@aws-sdk/client-shield 3.295.0 → 3.297.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 (46) hide show
  1. package/dist-types/Shield.d.ts +37 -0
  2. package/dist-types/ShieldClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateDRTLogBucketCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateDRTRoleCommand.d.ts +16 -0
  5. package/dist-types/commands/AssociateHealthCheckCommand.d.ts +16 -0
  6. package/dist-types/commands/AssociateProactiveEngagementDetailsCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProtectionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateProtectionGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateSubscriptionCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteProtectionCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteProtectionGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteSubscriptionCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeAttackCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeAttackStatisticsCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeDRTAccessCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeEmergencyContactSettingsCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeProtectionCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeProtectionGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeSubscriptionCommand.d.ts +16 -0
  20. package/dist-types/commands/DisableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  21. package/dist-types/commands/DisableProactiveEngagementCommand.d.ts +16 -0
  22. package/dist-types/commands/DisassociateDRTLogBucketCommand.d.ts +16 -0
  23. package/dist-types/commands/DisassociateDRTRoleCommand.d.ts +16 -0
  24. package/dist-types/commands/DisassociateHealthCheckCommand.d.ts +16 -0
  25. package/dist-types/commands/EnableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  26. package/dist-types/commands/EnableProactiveEngagementCommand.d.ts +16 -0
  27. package/dist-types/commands/GetSubscriptionStateCommand.d.ts +16 -0
  28. package/dist-types/commands/ListAttacksCommand.d.ts +16 -0
  29. package/dist-types/commands/ListProtectionGroupsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListProtectionsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListResourcesInProtectionGroupCommand.d.ts +16 -0
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  35. package/dist-types/commands/UpdateApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  36. package/dist-types/commands/UpdateEmergencyContactSettingsCommand.d.ts +16 -0
  37. package/dist-types/commands/UpdateProtectionGroupCommand.d.ts +16 -0
  38. package/dist-types/commands/UpdateSubscriptionCommand.d.ts +16 -0
  39. package/dist-types/models/ShieldServiceException.d.ts +2 -0
  40. package/dist-types/models/models_0.d.ts +298 -2
  41. package/dist-types/pagination/Interfaces.d.ts +3 -0
  42. package/dist-types/pagination/ListAttacksPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListProtectionGroupsPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListProtectionsPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListResourcesInProtectionGroupPaginator.d.ts +3 -0
  46. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisableApplicationLayerAutomaticResponseRequest, DisableApplicationLayerAutomaticResponseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableApplicationLayerAutomaticResponseCommand}.
8
10
  */
9
11
  export interface DisableApplicationLayerAutomaticResponseCommandInput extends DisableApplicationLayerAutomaticResponseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableApplicationLayerAutomaticResponseCommand}.
13
17
  */
14
18
  export interface DisableApplicationLayerAutomaticResponseCommandOutput extends DisableApplicationLayerAutomaticResponseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This
18
23
  * stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DisableApplicationLayerAutomaticResponseCommandOutput extends D
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DisableApplicationLayerAutomaticResponseCommandInput - {@link DisableApplicationLayerAutomaticResponseCommandInput}
35
+ * @returns {@link DisableApplicationLayerAutomaticResponseCommandOutput}
29
36
  * @see {@link DisableApplicationLayerAutomaticResponseCommandInput} for command's `input` shape.
30
37
  * @see {@link DisableApplicationLayerAutomaticResponseCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DisableApplicationLayerAutomaticResponseCommandOutput extends D
51
58
  export declare class DisableApplicationLayerAutomaticResponseCommand extends $Command<DisableApplicationLayerAutomaticResponseCommandInput, DisableApplicationLayerAutomaticResponseCommandOutput, ShieldClientResolvedConfig> {
52
59
  readonly input: DisableApplicationLayerAutomaticResponseCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DisableApplicationLayerAutomaticResponseCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableApplicationLayerAutomaticResponseCommandInput, DisableApplicationLayerAutomaticResponseCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisableProactiveEngagementRequest, DisableProactiveEngagementResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableProactiveEngagementCommand}.
8
10
  */
9
11
  export interface DisableProactiveEngagementCommandInput extends DisableProactiveEngagementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableProactiveEngagementCommand}.
13
17
  */
14
18
  export interface DisableProactiveEngagementCommandOutput extends DisableProactiveEngagementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.</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 DisableProactiveEngagementCommandOutput extends DisableProactiv
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisableProactiveEngagementCommandInput - {@link DisableProactiveEngagementCommandInput}
34
+ * @returns {@link DisableProactiveEngagementCommandOutput}
28
35
  * @see {@link DisableProactiveEngagementCommandInput} for command's `input` shape.
29
36
  * @see {@link DisableProactiveEngagementCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DisableProactiveEngagementCommandOutput extends DisableProactiv
50
57
  export declare class DisableProactiveEngagementCommand extends $Command<DisableProactiveEngagementCommandInput, DisableProactiveEngagementCommandOutput, ShieldClientResolvedConfig> {
51
58
  readonly input: DisableProactiveEngagementCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DisableProactiveEngagementCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableProactiveEngagementCommandInput, DisableProactiveEngagementCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateDRTLogBucketRequest, DisassociateDRTLogBucketResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateDRTLogBucketCommand}.
8
10
  */
9
11
  export interface DisassociateDRTLogBucketCommandInput extends DisassociateDRTLogBucketRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateDRTLogBucketCommand}.
13
17
  */
14
18
  export interface DisassociateDRTLogBucketCommandOutput extends DisassociateDRTLogBucketResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.</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 DisassociateDRTLogBucketCommandOutput extends DisassociateDRTLo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateDRTLogBucketCommandInput - {@link DisassociateDRTLogBucketCommandInput}
34
+ * @returns {@link DisassociateDRTLogBucketCommandOutput}
28
35
  * @see {@link DisassociateDRTLogBucketCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateDRTLogBucketCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DisassociateDRTLogBucketCommandOutput extends DisassociateDRTLo
53
60
  export declare class DisassociateDRTLogBucketCommand extends $Command<DisassociateDRTLogBucketCommandInput, DisassociateDRTLogBucketCommandOutput, ShieldClientResolvedConfig> {
54
61
  readonly input: DisassociateDRTLogBucketCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DisassociateDRTLogBucketCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateDRTLogBucketCommandInput, DisassociateDRTLogBucketCommandOutput>;
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 { DisassociateDRTRoleRequest, DisassociateDRTRoleResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateDRTRoleCommand}.
8
10
  */
9
11
  export interface DisassociateDRTRoleCommandInput extends DisassociateDRTRoleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateDRTRoleCommand}.
13
17
  */
14
18
  export interface DisassociateDRTRoleCommandOutput extends DisassociateDRTRoleResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.</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 DisassociateDRTRoleCommandOutput extends DisassociateDRTRoleRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateDRTRoleCommandInput - {@link DisassociateDRTRoleCommandInput}
34
+ * @returns {@link DisassociateDRTRoleCommandOutput}
28
35
  * @see {@link DisassociateDRTRoleCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateDRTRoleCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DisassociateDRTRoleCommandOutput extends DisassociateDRTRoleRes
47
54
  export declare class DisassociateDRTRoleCommand extends $Command<DisassociateDRTRoleCommandInput, DisassociateDRTRoleCommandOutput, ShieldClientResolvedConfig> {
48
55
  readonly input: DisassociateDRTRoleCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DisassociateDRTRoleCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateDRTRoleCommandInput, DisassociateDRTRoleCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateHealthCheckRequest, DisassociateHealthCheckResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateHealthCheckCommand}.
8
10
  */
9
11
  export interface DisassociateHealthCheckCommandInput extends DisassociateHealthCheckRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateHealthCheckCommand}.
13
17
  */
14
18
  export interface DisassociateHealthCheckCommandOutput extends DisassociateHealthCheckResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DisassociateHealthCheckCommandOutput extends DisassociateHealth
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DisassociateHealthCheckCommandInput - {@link DisassociateHealthCheckCommandInput}
35
+ * @returns {@link DisassociateHealthCheckCommandOutput}
29
36
  * @see {@link DisassociateHealthCheckCommandInput} for command's `input` shape.
30
37
  * @see {@link DisassociateHealthCheckCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DisassociateHealthCheckCommandOutput extends DisassociateHealth
51
58
  export declare class DisassociateHealthCheckCommand extends $Command<DisassociateHealthCheckCommandInput, DisassociateHealthCheckCommandOutput, ShieldClientResolvedConfig> {
52
59
  readonly input: DisassociateHealthCheckCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DisassociateHealthCheckCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateHealthCheckCommandInput, DisassociateHealthCheckCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EnableApplicationLayerAutomaticResponseRequest, EnableApplicationLayerAutomaticResponseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableApplicationLayerAutomaticResponseCommand}.
8
10
  */
9
11
  export interface EnableApplicationLayerAutomaticResponseCommandInput extends EnableApplicationLayerAutomaticResponseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableApplicationLayerAutomaticResponseCommand}.
13
17
  */
14
18
  export interface EnableApplicationLayerAutomaticResponseCommandOutput extends EnableApplicationLayerAutomaticResponseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. </p>
18
23
  * <note>
19
24
  * <p>This feature is available for Amazon CloudFront distributions and Application Load Balancers only.</p>
@@ -39,6 +44,8 @@ export interface EnableApplicationLayerAutomaticResponseCommandOutput extends En
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param EnableApplicationLayerAutomaticResponseCommandInput - {@link EnableApplicationLayerAutomaticResponseCommandInput}
48
+ * @returns {@link EnableApplicationLayerAutomaticResponseCommandOutput}
42
49
  * @see {@link EnableApplicationLayerAutomaticResponseCommandInput} for command's `input` shape.
43
50
  * @see {@link EnableApplicationLayerAutomaticResponseCommandOutput} for command's `response` shape.
44
51
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -67,11 +74,20 @@ export interface EnableApplicationLayerAutomaticResponseCommandOutput extends En
67
74
  export declare class EnableApplicationLayerAutomaticResponseCommand extends $Command<EnableApplicationLayerAutomaticResponseCommandInput, EnableApplicationLayerAutomaticResponseCommandOutput, ShieldClientResolvedConfig> {
68
75
  readonly input: EnableApplicationLayerAutomaticResponseCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: EnableApplicationLayerAutomaticResponseCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableApplicationLayerAutomaticResponseCommandInput, EnableApplicationLayerAutomaticResponseCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EnableProactiveEngagementRequest, EnableProactiveEngagementResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableProactiveEngagementCommand}.
8
10
  */
9
11
  export interface EnableProactiveEngagementCommandInput extends EnableProactiveEngagementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableProactiveEngagementCommand}.
13
17
  */
14
18
  export interface EnableProactiveEngagementCommandOutput extends EnableProactiveEngagementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 EnableProactiveEngagementCommandOutput extends EnableProactiveE
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param EnableProactiveEngagementCommandInput - {@link EnableProactiveEngagementCommandInput}
34
+ * @returns {@link EnableProactiveEngagementCommandOutput}
28
35
  * @see {@link EnableProactiveEngagementCommandInput} for command's `input` shape.
29
36
  * @see {@link EnableProactiveEngagementCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -50,11 +57,20 @@ export interface EnableProactiveEngagementCommandOutput extends EnableProactiveE
50
57
  export declare class EnableProactiveEngagementCommand extends $Command<EnableProactiveEngagementCommandInput, EnableProactiveEngagementCommandOutput, ShieldClientResolvedConfig> {
51
58
  readonly input: EnableProactiveEngagementCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: EnableProactiveEngagementCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableProactiveEngagementCommandInput, EnableProactiveEngagementCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSubscriptionStateRequest, GetSubscriptionStateResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSubscriptionStateCommand}.
8
10
  */
9
11
  export interface GetSubscriptionStateCommandInput extends GetSubscriptionStateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSubscriptionStateCommand}.
13
17
  */
14
18
  export interface GetSubscriptionStateCommandOutput extends GetSubscriptionStateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the <code>SubscriptionState</code>, either <code>Active</code> or <code>Inactive</code>.</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 GetSubscriptionStateCommandOutput extends GetSubscriptionStateR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSubscriptionStateCommandInput - {@link GetSubscriptionStateCommandInput}
34
+ * @returns {@link GetSubscriptionStateCommandOutput}
28
35
  * @see {@link GetSubscriptionStateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSubscriptionStateCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -37,11 +44,20 @@ export interface GetSubscriptionStateCommandOutput extends GetSubscriptionStateR
37
44
  export declare class GetSubscriptionStateCommand extends $Command<GetSubscriptionStateCommandInput, GetSubscriptionStateCommandOutput, ShieldClientResolvedConfig> {
38
45
  readonly input: GetSubscriptionStateCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: GetSubscriptionStateCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSubscriptionStateCommandInput, GetSubscriptionStateCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAttacksRequest, ListAttacksResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAttacksCommand}.
8
10
  */
9
11
  export interface ListAttacksCommandInput extends ListAttacksRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAttacksCommand}.
13
17
  */
14
18
  export interface ListAttacksCommandOutput extends ListAttacksResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns all ongoing DDoS attacks or all DDoS attacks during a specified time
18
23
  * period.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListAttacksCommandOutput extends ListAttacksResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListAttacksCommandInput - {@link ListAttacksCommandInput}
35
+ * @returns {@link ListAttacksCommandOutput}
29
36
  * @see {@link ListAttacksCommandInput} for command's `input` shape.
30
37
  * @see {@link ListAttacksCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListAttacksCommandOutput extends ListAttacksResponse, __Metadat
44
51
  export declare class ListAttacksCommand extends $Command<ListAttacksCommandInput, ListAttacksCommandOutput, ShieldClientResolvedConfig> {
45
52
  readonly input: ListAttacksCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListAttacksCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAttacksCommandInput, ListAttacksCommandOutput>;
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 { ListProtectionGroupsRequest, ListProtectionGroupsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListProtectionGroupsCommand}.
8
10
  */
9
11
  export interface ListProtectionGroupsCommandInput extends ListProtectionGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListProtectionGroupsCommand}.
13
17
  */
14
18
  export interface ListProtectionGroupsCommandOutput extends ListProtectionGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves <a>ProtectionGroup</a> objects for the account. You can retrieve all protection groups or you can provide
18
23
  * filtering criteria and retrieve just the subset of protection groups that match the criteria. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListProtectionGroupsCommandOutput extends ListProtectionGroupsR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListProtectionGroupsCommandInput - {@link ListProtectionGroupsCommandInput}
35
+ * @returns {@link ListProtectionGroupsCommandOutput}
29
36
  * @see {@link ListProtectionGroupsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListProtectionGroupsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListProtectionGroupsCommandOutput extends ListProtectionGroupsR
44
51
  export declare class ListProtectionGroupsCommand extends $Command<ListProtectionGroupsCommandInput, ListProtectionGroupsCommandOutput, ShieldClientResolvedConfig> {
45
52
  readonly input: ListProtectionGroupsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListProtectionGroupsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListProtectionGroupsCommandInput, ListProtectionGroupsCommandOutput>;
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 { ListProtectionsRequest, ListProtectionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListProtectionsCommand}.
8
10
  */
9
11
  export interface ListProtectionsCommandInput extends ListProtectionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListProtectionsCommand}.
13
17
  */
14
18
  export interface ListProtectionsCommandOutput extends ListProtectionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves <a>Protection</a> objects for the account. You can retrieve all protections or you can provide
18
23
  * filtering criteria and retrieve just the subset of protections that match the criteria. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListProtectionsCommandOutput extends ListProtectionsResponse, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListProtectionsCommandInput - {@link ListProtectionsCommandInput}
35
+ * @returns {@link ListProtectionsCommandOutput}
29
36
  * @see {@link ListProtectionsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListProtectionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListProtectionsCommandOutput extends ListProtectionsResponse, _
44
51
  export declare class ListProtectionsCommand extends $Command<ListProtectionsCommandInput, ListProtectionsCommandOutput, ShieldClientResolvedConfig> {
45
52
  readonly input: ListProtectionsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListProtectionsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListProtectionsCommandInput, ListProtectionsCommandOutput>;
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 { ListResourcesInProtectionGroupRequest, ListResourcesInProtectionGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListResourcesInProtectionGroupCommand}.
8
10
  */
9
11
  export interface ListResourcesInProtectionGroupCommandInput extends ListResourcesInProtectionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListResourcesInProtectionGroupCommand}.
13
17
  */
14
18
  export interface ListResourcesInProtectionGroupCommandOutput extends ListResourcesInProtectionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the resources that are included in the 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 ListResourcesInProtectionGroupCommandOutput extends ListResourc
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListResourcesInProtectionGroupCommandInput - {@link ListResourcesInProtectionGroupCommandInput}
34
+ * @returns {@link ListResourcesInProtectionGroupCommandOutput}
28
35
  * @see {@link ListResourcesInProtectionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link ListResourcesInProtectionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListResourcesInProtectionGroupCommandOutput extends ListResourc
43
50
  export declare class ListResourcesInProtectionGroupCommand extends $Command<ListResourcesInProtectionGroupCommandInput, ListResourcesInProtectionGroupCommandOutput, ShieldClientResolvedConfig> {
44
51
  readonly input: ListResourcesInProtectionGroupCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListResourcesInProtectionGroupCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListResourcesInProtectionGroupCommandInput, ListResourcesInProtectionGroupCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }