@aws-sdk/client-shield 3.312.0 → 3.316.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.
@@ -36,315 +36,230 @@ import { UpdateEmergencyContactSettingsCommandInput, UpdateEmergencyContactSetti
36
36
  import { UpdateProtectionGroupCommandInput, UpdateProtectionGroupCommandOutput } from "./commands/UpdateProtectionGroupCommand";
37
37
  import { UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput } from "./commands/UpdateSubscriptionCommand";
38
38
  import { ShieldClient } from "./ShieldClient";
39
- /**
40
- * @public
41
- * <fullname>Shield Advanced</fullname>
42
- * <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,
43
- * 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
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">WAF and Shield Developer Guide</a>.</p>
45
- */
46
- export declare class Shield extends ShieldClient {
39
+ export interface Shield {
47
40
  /**
48
- * @public
49
- * <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>
50
- * <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>
41
+ * @see {@link AssociateDRTLogBucketCommand}
51
42
  */
52
43
  associateDRTLogBucket(args: AssociateDRTLogBucketCommandInput, options?: __HttpHandlerOptions): Promise<AssociateDRTLogBucketCommandOutput>;
53
44
  associateDRTLogBucket(args: AssociateDRTLogBucketCommandInput, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void): void;
54
45
  associateDRTLogBucket(args: AssociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void): void;
55
46
  /**
56
- * @public
57
- * <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>
58
- * <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>
59
- * <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
60
- * <code>drt.shield.amazonaws.com</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM JSON policy elements: Principal</a>.</p>
61
- *
62
- * <p>The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.</p>
63
- * <p>You must have the <code>iam:PassRole</code> permission to make an <code>AssociateDRTRole</code> request. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a user permissions to pass a role to an Amazon Web Services service</a>. </p>
64
- * <p>To use the services of the SRT and make an <code>AssociateDRTRole</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>
47
+ * @see {@link AssociateDRTRoleCommand}
65
48
  */
66
49
  associateDRTRole(args: AssociateDRTRoleCommandInput, options?: __HttpHandlerOptions): Promise<AssociateDRTRoleCommandOutput>;
67
50
  associateDRTRole(args: AssociateDRTRoleCommandInput, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void): void;
68
51
  associateDRTRole(args: AssociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void): void;
69
52
  /**
70
- * @public
71
- * <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>
72
- * <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>
53
+ * @see {@link AssociateHealthCheckCommand}
73
54
  */
74
55
  associateHealthCheck(args: AssociateHealthCheckCommandInput, options?: __HttpHandlerOptions): Promise<AssociateHealthCheckCommandOutput>;
75
56
  associateHealthCheck(args: AssociateHealthCheckCommandInput, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void): void;
76
57
  associateHealthCheck(args: AssociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void): void;
77
58
  /**
78
- * @public
79
- * <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>
80
- * <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>
81
- * <note>
82
- * <p>This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.</p>
83
- * <p>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 <code>DescribeEmergencyContactSettings</code> and then provide it to this call. </p>
84
- * </note>
59
+ * @see {@link AssociateProactiveEngagementDetailsCommand}
85
60
  */
86
61
  associateProactiveEngagementDetails(args: AssociateProactiveEngagementDetailsCommandInput, options?: __HttpHandlerOptions): Promise<AssociateProactiveEngagementDetailsCommandOutput>;
87
62
  associateProactiveEngagementDetails(args: AssociateProactiveEngagementDetailsCommandInput, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void): void;
88
63
  associateProactiveEngagementDetails(args: AssociateProactiveEngagementDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void): void;
89
64
  /**
90
- * @public
91
- * <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>
92
- * <p>You can add protection to only a single resource with each <code>CreateProtection</code> request. You can add protection to multiple resources
93
- * 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>.
94
- * For more information see
95
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html">Getting Started with Shield Advanced</a>
96
- * and <a href="https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html">Adding Shield Advanced protection to Amazon Web Services resources</a>.</p>
65
+ * @see {@link CreateProtectionCommand}
97
66
  */
98
67
  createProtection(args: CreateProtectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateProtectionCommandOutput>;
99
68
  createProtection(args: CreateProtectionCommandInput, cb: (err: any, data?: CreateProtectionCommandOutput) => void): void;
100
69
  createProtection(args: CreateProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionCommandOutput) => void): void;
101
70
  /**
102
- * @public
103
- * <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>
71
+ * @see {@link CreateProtectionGroupCommand}
104
72
  */
105
73
  createProtectionGroup(args: CreateProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateProtectionGroupCommandOutput>;
106
74
  createProtectionGroup(args: CreateProtectionGroupCommandInput, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void): void;
107
75
  createProtectionGroup(args: CreateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void): void;
108
76
  /**
109
- * @public
110
- * <p>Activates Shield Advanced for an account.</p>
111
- * <note>
112
- * <p>For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account,
113
- * regardless of whether the payer account itself is subscribed. </p>
114
- * </note>
115
- * <p>When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an <code>UpdateSubscription</code> request. </p>
77
+ * @see {@link CreateSubscriptionCommand}
116
78
  */
117
79
  createSubscription(args: CreateSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubscriptionCommandOutput>;
118
80
  createSubscription(args: CreateSubscriptionCommandInput, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void): void;
119
81
  createSubscription(args: CreateSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void): void;
120
82
  /**
121
- * @public
122
- * <p>Deletes an Shield Advanced <a>Protection</a>.</p>
83
+ * @see {@link DeleteProtectionCommand}
123
84
  */
124
85
  deleteProtection(args: DeleteProtectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProtectionCommandOutput>;
125
86
  deleteProtection(args: DeleteProtectionCommandInput, cb: (err: any, data?: DeleteProtectionCommandOutput) => void): void;
126
87
  deleteProtection(args: DeleteProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionCommandOutput) => void): void;
127
88
  /**
128
- * @public
129
- * <p>Removes the specified protection group.</p>
89
+ * @see {@link DeleteProtectionGroupCommand}
130
90
  */
131
91
  deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProtectionGroupCommandOutput>;
132
92
  deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void): void;
133
93
  deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void): void;
134
94
  /**
135
- * @public
136
- * @deprecated
137
- *
138
- * <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>
95
+ * @see {@link DeleteSubscriptionCommand}
139
96
  */
140
97
  deleteSubscription(args: DeleteSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriptionCommandOutput>;
141
98
  deleteSubscription(args: DeleteSubscriptionCommandInput, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void): void;
142
99
  deleteSubscription(args: DeleteSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void): void;
143
100
  /**
144
- * @public
145
- * <p>Describes the details of a DDoS attack. </p>
101
+ * @see {@link DescribeAttackCommand}
146
102
  */
147
103
  describeAttack(args: DescribeAttackCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAttackCommandOutput>;
148
104
  describeAttack(args: DescribeAttackCommandInput, cb: (err: any, data?: DescribeAttackCommandOutput) => void): void;
149
105
  describeAttack(args: DescribeAttackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackCommandOutput) => void): void;
150
106
  /**
151
- * @public
152
- * <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>
153
- * <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>
154
- * <p>The time range indicates the period covered by the attack statistics data items.</p>
107
+ * @see {@link DescribeAttackStatisticsCommand}
155
108
  */
156
109
  describeAttackStatistics(args: DescribeAttackStatisticsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAttackStatisticsCommandOutput>;
157
110
  describeAttackStatistics(args: DescribeAttackStatisticsCommandInput, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void): void;
158
111
  describeAttackStatistics(args: DescribeAttackStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void): void;
159
112
  /**
160
- * @public
161
- * <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>
113
+ * @see {@link DescribeDRTAccessCommand}
162
114
  */
163
115
  describeDRTAccess(args: DescribeDRTAccessCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDRTAccessCommandOutput>;
164
116
  describeDRTAccess(args: DescribeDRTAccessCommandInput, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void): void;
165
117
  describeDRTAccess(args: DescribeDRTAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void): void;
166
118
  /**
167
- * @public
168
- * <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>
119
+ * @see {@link DescribeEmergencyContactSettingsCommand}
169
120
  */
170
121
  describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEmergencyContactSettingsCommandOutput>;
171
122
  describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void): void;
172
123
  describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void): void;
173
124
  /**
174
- * @public
175
- * <p>Lists the details of a <a>Protection</a> object.</p>
125
+ * @see {@link DescribeProtectionCommand}
176
126
  */
177
127
  describeProtection(args: DescribeProtectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProtectionCommandOutput>;
178
128
  describeProtection(args: DescribeProtectionCommandInput, cb: (err: any, data?: DescribeProtectionCommandOutput) => void): void;
179
129
  describeProtection(args: DescribeProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionCommandOutput) => void): void;
180
130
  /**
181
- * @public
182
- * <p>Returns the specification for the specified protection group.</p>
131
+ * @see {@link DescribeProtectionGroupCommand}
183
132
  */
184
133
  describeProtectionGroup(args: DescribeProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProtectionGroupCommandOutput>;
185
134
  describeProtectionGroup(args: DescribeProtectionGroupCommandInput, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void): void;
186
135
  describeProtectionGroup(args: DescribeProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void): void;
187
136
  /**
188
- * @public
189
- * <p>Provides details about the Shield Advanced subscription for an account.</p>
137
+ * @see {@link DescribeSubscriptionCommand}
190
138
  */
191
139
  describeSubscription(args: DescribeSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSubscriptionCommandOutput>;
192
140
  describeSubscription(args: DescribeSubscriptionCommandInput, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void): void;
193
141
  describeSubscription(args: DescribeSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void): void;
194
142
  /**
195
- * @public
196
- * <p>Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This
197
- * stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource. </p>
143
+ * @see {@link DisableApplicationLayerAutomaticResponseCommand}
198
144
  */
199
145
  disableApplicationLayerAutomaticResponse(args: DisableApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions): Promise<DisableApplicationLayerAutomaticResponseCommandOutput>;
200
146
  disableApplicationLayerAutomaticResponse(args: DisableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void): void;
201
147
  disableApplicationLayerAutomaticResponse(args: DisableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void): void;
202
148
  /**
203
- * @public
204
- * <p>Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.</p>
149
+ * @see {@link DisableProactiveEngagementCommand}
205
150
  */
206
151
  disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, options?: __HttpHandlerOptions): Promise<DisableProactiveEngagementCommandOutput>;
207
152
  disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void): void;
208
153
  disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void): void;
209
154
  /**
210
- * @public
211
- * <p>Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.</p>
155
+ * @see {@link DisassociateDRTLogBucketCommand}
212
156
  */
213
157
  disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDRTLogBucketCommandOutput>;
214
158
  disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void): void;
215
159
  disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void): void;
216
160
  /**
217
- * @public
218
- * <p>Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.</p>
161
+ * @see {@link DisassociateDRTRoleCommand}
219
162
  */
220
163
  disassociateDRTRole(args: DisassociateDRTRoleCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDRTRoleCommandOutput>;
221
164
  disassociateDRTRole(args: DisassociateDRTRoleCommandInput, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void): void;
222
165
  disassociateDRTRole(args: DisassociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void): void;
223
166
  /**
224
- * @public
225
- * <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>
226
- * <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>
167
+ * @see {@link DisassociateHealthCheckCommand}
227
168
  */
228
169
  disassociateHealthCheck(args: DisassociateHealthCheckCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateHealthCheckCommandOutput>;
229
170
  disassociateHealthCheck(args: DisassociateHealthCheckCommandInput, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void): void;
230
171
  disassociateHealthCheck(args: DisassociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void): void;
231
172
  /**
232
- * @public
233
- * <p>Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. </p>
234
- * <note>
235
- * <p>This feature is available for Amazon CloudFront distributions and Application Load Balancers only.</p>
236
- * </note>
237
- * <p>This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the
238
- * resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated
239
- * with the resource. For information about how automatic mitigation works and the requirements for using it, see
240
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html">Shield Advanced automatic application layer DDoS mitigation</a>.</p>
241
- * <note>
242
- * <p>Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use <a>UpdateApplicationLayerAutomaticResponse</a>.</p>
243
- * </note>
244
- * <p>To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console
245
- * at <a href="https://console.aws.amazon.com/wafv2/shieldv2#/">https://console.aws.amazon.com/wafv2/shieldv2#/</a>. For more information,
246
- * see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html">Getting Started with Shield Advanced</a>. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see
247
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">WAF Developer Guide</a>.</p>
173
+ * @see {@link EnableApplicationLayerAutomaticResponseCommand}
248
174
  */
249
175
  enableApplicationLayerAutomaticResponse(args: EnableApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions): Promise<EnableApplicationLayerAutomaticResponseCommandOutput>;
250
176
  enableApplicationLayerAutomaticResponse(args: EnableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void): void;
251
177
  enableApplicationLayerAutomaticResponse(args: EnableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void): void;
252
178
  /**
253
- * @public
254
- * <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>
179
+ * @see {@link EnableProactiveEngagementCommand}
255
180
  */
256
181
  enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, options?: __HttpHandlerOptions): Promise<EnableProactiveEngagementCommandOutput>;
257
182
  enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void): void;
258
183
  enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void): void;
259
184
  /**
260
- * @public
261
- * <p>Returns the <code>SubscriptionState</code>, either <code>Active</code> or <code>Inactive</code>.</p>
185
+ * @see {@link GetSubscriptionStateCommand}
262
186
  */
263
187
  getSubscriptionState(args: GetSubscriptionStateCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriptionStateCommandOutput>;
264
188
  getSubscriptionState(args: GetSubscriptionStateCommandInput, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void): void;
265
189
  getSubscriptionState(args: GetSubscriptionStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void): void;
266
190
  /**
267
- * @public
268
- * <p>Returns all ongoing DDoS attacks or all DDoS attacks during a specified time
269
- * period.</p>
191
+ * @see {@link ListAttacksCommand}
270
192
  */
271
193
  listAttacks(args: ListAttacksCommandInput, options?: __HttpHandlerOptions): Promise<ListAttacksCommandOutput>;
272
194
  listAttacks(args: ListAttacksCommandInput, cb: (err: any, data?: ListAttacksCommandOutput) => void): void;
273
195
  listAttacks(args: ListAttacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttacksCommandOutput) => void): void;
274
196
  /**
275
- * @public
276
- * <p>Retrieves <a>ProtectionGroup</a> objects for the account. You can retrieve all protection groups or you can provide
277
- * filtering criteria and retrieve just the subset of protection groups that match the criteria. </p>
197
+ * @see {@link ListProtectionGroupsCommand}
278
198
  */
279
199
  listProtectionGroups(args: ListProtectionGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListProtectionGroupsCommandOutput>;
280
200
  listProtectionGroups(args: ListProtectionGroupsCommandInput, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void): void;
281
201
  listProtectionGroups(args: ListProtectionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void): void;
282
202
  /**
283
- * @public
284
- * <p>Retrieves <a>Protection</a> objects for the account. You can retrieve all protections or you can provide
285
- * filtering criteria and retrieve just the subset of protections that match the criteria. </p>
203
+ * @see {@link ListProtectionsCommand}
286
204
  */
287
205
  listProtections(args: ListProtectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListProtectionsCommandOutput>;
288
206
  listProtections(args: ListProtectionsCommandInput, cb: (err: any, data?: ListProtectionsCommandOutput) => void): void;
289
207
  listProtections(args: ListProtectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionsCommandOutput) => void): void;
290
208
  /**
291
- * @public
292
- * <p>Retrieves the resources that are included in the protection group. </p>
209
+ * @see {@link ListResourcesInProtectionGroupCommand}
293
210
  */
294
211
  listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcesInProtectionGroupCommandOutput>;
295
212
  listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void): void;
296
213
  listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void): void;
297
214
  /**
298
- * @public
299
- * <p>Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.</p>
215
+ * @see {@link ListTagsForResourceCommand}
300
216
  */
301
217
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
302
218
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
303
219
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
304
220
  /**
305
- * @public
306
- * <p>Adds or updates tags for a resource in Shield.</p>
221
+ * @see {@link TagResourceCommand}
307
222
  */
308
223
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
309
224
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
310
225
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
311
226
  /**
312
- * @public
313
- * <p>Removes tags from a resource in Shield.</p>
227
+ * @see {@link UntagResourceCommand}
314
228
  */
315
229
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
316
230
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
317
231
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
318
232
  /**
319
- * @public
320
- * <p>Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.</p>
233
+ * @see {@link UpdateApplicationLayerAutomaticResponseCommand}
321
234
  */
322
235
  updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions): Promise<UpdateApplicationLayerAutomaticResponseCommandOutput>;
323
236
  updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void): void;
324
237
  updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void): void;
325
238
  /**
326
- * @public
327
- * <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>
239
+ * @see {@link UpdateEmergencyContactSettingsCommand}
328
240
  */
329
241
  updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEmergencyContactSettingsCommandOutput>;
330
242
  updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void): void;
331
243
  updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void): void;
332
244
  /**
333
- * @public
334
- * <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>
245
+ * @see {@link UpdateProtectionGroupCommand}
335
246
  */
336
247
  updateProtectionGroup(args: UpdateProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateProtectionGroupCommandOutput>;
337
248
  updateProtectionGroup(args: UpdateProtectionGroupCommandInput, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void): void;
338
249
  updateProtectionGroup(args: UpdateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void): void;
339
250
  /**
340
- * @public
341
- * <p>Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.</p>
342
- * <note>
343
- * <p>For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account,
344
- * regardless of whether the payer account itself is subscribed. </p>
345
- * </note>
251
+ * @see {@link UpdateSubscriptionCommand}
346
252
  */
347
253
  updateSubscription(args: UpdateSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubscriptionCommandOutput>;
348
254
  updateSubscription(args: UpdateSubscriptionCommandInput, cb: (err: any, data?: UpdateSubscriptionCommandOutput) => void): void;
349
255
  updateSubscription(args: UpdateSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionCommandOutput) => void): void;
350
256
  }
257
+ /**
258
+ * @public
259
+ * <fullname>Shield Advanced</fullname>
260
+ * <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,
261
+ * 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
262
+ * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">WAF and Shield Developer Guide</a>.</p>
263
+ */
264
+ export declare class Shield extends ShieldClient implements Shield {
265
+ }
@@ -144,7 +144,7 @@ import {
144
144
  UpdateSubscriptionCommandOutput,
145
145
  } from "./commands/UpdateSubscriptionCommand";
146
146
  import { ShieldClient } from "./ShieldClient";
147
- export declare class Shield extends ShieldClient {
147
+ export interface Shield {
148
148
  associateDRTLogBucket(
149
149
  args: AssociateDRTLogBucketCommandInput,
150
150
  options?: __HttpHandlerOptions
@@ -638,3 +638,4 @@ export declare class Shield extends ShieldClient {
638
638
  cb: (err: any, data?: UpdateSubscriptionCommandOutput) => void
639
639
  ): void;
640
640
  }
641
+ export declare class Shield extends ShieldClient implements Shield {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-shield",
3
3
  "description": "AWS SDK for JavaScript Shield Client for Node.js, Browser and React Native",
4
- "version": "3.312.0",
4
+ "version": "3.316.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.312.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.310.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.310.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.310.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",