@aws-sdk/client-backup-gateway 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 (34) hide show
  1. package/dist-types/BackupGateway.d.ts +26 -0
  2. package/dist-types/BackupGatewayClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateGatewayToServerCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateGatewayCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteGatewayCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteHypervisorCommand.d.ts +16 -0
  7. package/dist-types/commands/DisassociateGatewayFromServerCommand.d.ts +16 -0
  8. package/dist-types/commands/GetBandwidthRateLimitScheduleCommand.d.ts +16 -0
  9. package/dist-types/commands/GetGatewayCommand.d.ts +16 -0
  10. package/dist-types/commands/GetHypervisorCommand.d.ts +16 -0
  11. package/dist-types/commands/GetHypervisorPropertyMappingsCommand.d.ts +16 -0
  12. package/dist-types/commands/GetVirtualMachineCommand.d.ts +16 -0
  13. package/dist-types/commands/ImportHypervisorConfigurationCommand.d.ts +16 -0
  14. package/dist-types/commands/ListGatewaysCommand.d.ts +16 -0
  15. package/dist-types/commands/ListHypervisorsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  17. package/dist-types/commands/ListVirtualMachinesCommand.d.ts +16 -0
  18. package/dist-types/commands/PutBandwidthRateLimitScheduleCommand.d.ts +16 -0
  19. package/dist-types/commands/PutHypervisorPropertyMappingsCommand.d.ts +16 -0
  20. package/dist-types/commands/PutMaintenanceStartTimeCommand.d.ts +16 -0
  21. package/dist-types/commands/StartVirtualMachinesMetadataSyncCommand.d.ts +16 -0
  22. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/TestHypervisorConfigurationCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateHypervisorCommand.d.ts +16 -0
  28. package/dist-types/models/BackupGatewayServiceException.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +176 -0
  30. package/dist-types/pagination/Interfaces.d.ts +3 -0
  31. package/dist-types/pagination/ListGatewaysPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListHypervisorsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListVirtualMachinesPaginator.d.ts +3 -0
  34. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { TagResourceInput, TagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Tag the resource.</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 TagResourceCommandOutput extends TagResourceOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -47,11 +54,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
47
54
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BackupGatewayClientResolvedConfig> {
48
55
  readonly input: TagResourceCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: TagResourceCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { TestHypervisorConfigurationInput, TestHypervisorConfigurationOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TestHypervisorConfigurationCommand}.
8
10
  */
9
11
  export interface TestHypervisorConfigurationCommandInput extends TestHypervisorConfigurationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TestHypervisorConfigurationCommand}.
13
17
  */
14
18
  export interface TestHypervisorConfigurationCommandOutput extends TestHypervisorConfigurationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Tests your hypervisor configuration to validate that backup gateway can connect with the
18
23
  * hypervisor and its resources.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface TestHypervisorConfigurationCommandOutput extends TestHypervisor
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param TestHypervisorConfigurationCommandInput - {@link TestHypervisorConfigurationCommandInput}
35
+ * @returns {@link TestHypervisorConfigurationCommandOutput}
29
36
  * @see {@link TestHypervisorConfigurationCommandInput} for command's `input` shape.
30
37
  * @see {@link TestHypervisorConfigurationCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -51,11 +58,20 @@ export interface TestHypervisorConfigurationCommandOutput extends TestHypervisor
51
58
  export declare class TestHypervisorConfigurationCommand extends $Command<TestHypervisorConfigurationCommandInput, TestHypervisorConfigurationCommandOutput, BackupGatewayClientResolvedConfig> {
52
59
  readonly input: TestHypervisorConfigurationCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: TestHypervisorConfigurationCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestHypervisorConfigurationCommandInput, TestHypervisorConfigurationCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes tags from the resource.</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 UntagResourceCommandOutput extends UntagResourceOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -47,11 +54,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
47
54
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BackupGatewayClientResolvedConfig> {
48
55
  readonly input: UntagResourceCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: UntagResourceCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { UpdateGatewayInformationInput, UpdateGatewayInformationOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGatewayInformationCommand}.
8
10
  */
9
11
  export interface UpdateGatewayInformationCommandInput extends UpdateGatewayInformationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGatewayInformationCommand}.
13
17
  */
14
18
  export interface UpdateGatewayInformationCommandOutput extends UpdateGatewayInformationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name
18
23
  * (ARN) of the gateway in your request.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateGatewayInformationCommandOutput extends UpdateGatewayInfo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateGatewayInformationCommandInput - {@link UpdateGatewayInformationCommandInput}
35
+ * @returns {@link UpdateGatewayInformationCommandOutput}
29
36
  * @see {@link UpdateGatewayInformationCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateGatewayInformationCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UpdateGatewayInformationCommandOutput extends UpdateGatewayInfo
51
58
  export declare class UpdateGatewayInformationCommand extends $Command<UpdateGatewayInformationCommandInput, UpdateGatewayInformationCommandOutput, BackupGatewayClientResolvedConfig> {
52
59
  readonly input: UpdateGatewayInformationCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: UpdateGatewayInformationCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGatewayInformationCommandInput, UpdateGatewayInformationCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { UpdateGatewaySoftwareNowInput, UpdateGatewaySoftwareNowOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGatewaySoftwareNowCommand}.
8
10
  */
9
11
  export interface UpdateGatewaySoftwareNowCommandInput extends UpdateGatewaySoftwareNowInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGatewaySoftwareNowCommand}.
13
17
  */
14
18
  export interface UpdateGatewaySoftwareNowCommandOutput extends UpdateGatewaySoftwareNowOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the gateway virtual machine (VM) software.
18
23
  * The request immediately triggers the software update.</p>
19
24
  * <note>
@@ -31,6 +36,8 @@ export interface UpdateGatewaySoftwareNowCommandOutput extends UpdateGatewaySoft
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param UpdateGatewaySoftwareNowCommandInput - {@link UpdateGatewaySoftwareNowCommandInput}
40
+ * @returns {@link UpdateGatewaySoftwareNowCommandOutput}
34
41
  * @see {@link UpdateGatewaySoftwareNowCommandInput} for command's `input` shape.
35
42
  * @see {@link UpdateGatewaySoftwareNowCommandOutput} for command's `response` shape.
36
43
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateGatewaySoftwareNowCommandOutput extends UpdateGatewaySoft
53
60
  export declare class UpdateGatewaySoftwareNowCommand extends $Command<UpdateGatewaySoftwareNowCommandInput, UpdateGatewaySoftwareNowCommandOutput, BackupGatewayClientResolvedConfig> {
54
61
  readonly input: UpdateGatewaySoftwareNowCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateGatewaySoftwareNowCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGatewaySoftwareNowCommandInput, UpdateGatewaySoftwareNowCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { UpdateHypervisorInput, UpdateHypervisorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateHypervisorCommand}.
8
10
  */
9
11
  export interface UpdateHypervisorCommandInput extends UpdateHypervisorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateHypervisorCommand}.
13
17
  */
14
18
  export interface UpdateHypervisorCommandOutput extends UpdateHypervisorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a hypervisor metadata, including its host, username, and password. Specify which
18
23
  * hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your
19
24
  * request.</p>
@@ -27,6 +32,8 @@ export interface UpdateHypervisorCommandOutput extends UpdateHypervisorOutput, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UpdateHypervisorCommandInput - {@link UpdateHypervisorCommandInput}
36
+ * @returns {@link UpdateHypervisorCommandOutput}
30
37
  * @see {@link UpdateHypervisorCommandInput} for command's `input` shape.
31
38
  * @see {@link UpdateHypervisorCommandOutput} for command's `response` shape.
32
39
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateHypervisorCommandOutput extends UpdateHypervisorOutput, _
55
62
  export declare class UpdateHypervisorCommand extends $Command<UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput, BackupGatewayClientResolvedConfig> {
56
63
  readonly input: UpdateHypervisorCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: UpdateHypervisorCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from BackupGateway service.
4
6
  */
5
7
  export declare class BackupGatewayServiceException extends __ServiceException {