@aws-sdk/client-backup-gateway 3.296.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 +3 -3
@@ -26,6 +26,7 @@ import { UpdateGatewayInformationCommandInput, UpdateGatewayInformationCommandOu
26
26
  import { UpdateGatewaySoftwareNowCommandInput, UpdateGatewaySoftwareNowCommandOutput } from "./commands/UpdateGatewaySoftwareNowCommand";
27
27
  import { UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput } from "./commands/UpdateHypervisorCommand";
28
28
  /**
29
+ * @public
29
30
  * <fullname>Backup gateway</fullname>
30
31
  * <p>Backup gateway connects Backup to your hypervisor, so you can
31
32
  * create, store, and restore backups of your virtual machines (VMs) anywhere, whether
@@ -38,6 +39,7 @@ import { UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput } from "./c
38
39
  */
39
40
  export declare class BackupGateway extends BackupGatewayClient {
40
41
  /**
42
+ * @public
41
43
  * <p>Associates a backup gateway with your server. After you complete the association process,
42
44
  * you can back up and restore your VMs through the gateway.</p>
43
45
  */
@@ -45,6 +47,7 @@ export declare class BackupGateway extends BackupGatewayClient {
45
47
  associateGatewayToServer(args: AssociateGatewayToServerCommandInput, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void): void;
46
48
  associateGatewayToServer(args: AssociateGatewayToServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void): void;
47
49
  /**
50
+ * @public
48
51
  * <p>Creates a backup gateway. After you create a gateway, you can associate it with a server
49
52
  * using the <code>AssociateGatewayToServer</code> operation.</p>
50
53
  */
@@ -52,18 +55,21 @@ export declare class BackupGateway extends BackupGatewayClient {
52
55
  createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
53
56
  createGateway(args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
54
57
  /**
58
+ * @public
55
59
  * <p>Deletes a backup gateway.</p>
56
60
  */
57
61
  deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGatewayCommandOutput>;
58
62
  deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
59
63
  deleteGateway(args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
60
64
  /**
65
+ * @public
61
66
  * <p>Deletes a hypervisor.</p>
62
67
  */
63
68
  deleteHypervisor(args: DeleteHypervisorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHypervisorCommandOutput>;
64
69
  deleteHypervisor(args: DeleteHypervisorCommandInput, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void): void;
65
70
  deleteHypervisor(args: DeleteHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void): void;
66
71
  /**
72
+ * @public
67
73
  * <p>Disassociates a backup gateway from the specified server. After the disassociation process
68
74
  * finishes, the gateway can no longer access the virtual machines on the server.</p>
69
75
  */
@@ -71,6 +77,7 @@ export declare class BackupGateway extends BackupGatewayClient {
71
77
  disassociateGatewayFromServer(args: DisassociateGatewayFromServerCommandInput, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void): void;
72
78
  disassociateGatewayFromServer(args: DisassociateGatewayFromServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void): void;
73
79
  /**
80
+ * @public
74
81
  * <p>Retrieves the bandwidth rate limit schedule for a specified gateway.
75
82
  * By default, gateways do not have bandwidth rate limit schedules, which means
76
83
  * no bandwidth rate limiting is in effect. Use this to get a gateway's
@@ -80,6 +87,7 @@ export declare class BackupGateway extends BackupGatewayClient {
80
87
  getBandwidthRateLimitSchedule(args: GetBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void): void;
81
88
  getBandwidthRateLimitSchedule(args: GetBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void): void;
82
89
  /**
90
+ * @public
83
91
  * <p>By providing the ARN (Amazon Resource Name), this
84
92
  * API returns the gateway.</p>
85
93
  */
@@ -87,6 +95,7 @@ export declare class BackupGateway extends BackupGatewayClient {
87
95
  getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void;
88
96
  getGateway(args: GetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayCommandOutput) => void): void;
89
97
  /**
98
+ * @public
90
99
  * <p>This action requests information about the specified hypervisor to which the gateway will connect.
91
100
  * A hypervisor is hardware, software, or firmware that creates and manages virtual machines,
92
101
  * and allocates resources to them.</p>
@@ -95,6 +104,7 @@ export declare class BackupGateway extends BackupGatewayClient {
95
104
  getHypervisor(args: GetHypervisorCommandInput, cb: (err: any, data?: GetHypervisorCommandOutput) => void): void;
96
105
  getHypervisor(args: GetHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorCommandOutput) => void): void;
97
106
  /**
107
+ * @public
98
108
  * <p>This action retrieves the property mappings for the specified hypervisor.
99
109
  * A hypervisor property mapping displays the relationship of entity properties
100
110
  * available from the on-premises hypervisor to the properties available in Amazon Web Services.</p>
@@ -103,30 +113,35 @@ export declare class BackupGateway extends BackupGatewayClient {
103
113
  getHypervisorPropertyMappings(args: GetHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void): void;
104
114
  getHypervisorPropertyMappings(args: GetHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void): void;
105
115
  /**
116
+ * @public
106
117
  * <p>By providing the ARN (Amazon Resource Name), this API returns the virtual machine.</p>
107
118
  */
108
119
  getVirtualMachine(args: GetVirtualMachineCommandInput, options?: __HttpHandlerOptions): Promise<GetVirtualMachineCommandOutput>;
109
120
  getVirtualMachine(args: GetVirtualMachineCommandInput, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void): void;
110
121
  getVirtualMachine(args: GetVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void): void;
111
122
  /**
123
+ * @public
112
124
  * <p>Connect to a hypervisor by importing its configuration.</p>
113
125
  */
114
126
  importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<ImportHypervisorConfigurationCommandOutput>;
115
127
  importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void): void;
116
128
  importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void): void;
117
129
  /**
130
+ * @public
118
131
  * <p>Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).</p>
119
132
  */
120
133
  listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise<ListGatewaysCommandOutput>;
121
134
  listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
122
135
  listGateways(args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
123
136
  /**
137
+ * @public
124
138
  * <p>Lists your hypervisors.</p>
125
139
  */
126
140
  listHypervisors(args: ListHypervisorsCommandInput, options?: __HttpHandlerOptions): Promise<ListHypervisorsCommandOutput>;
127
141
  listHypervisors(args: ListHypervisorsCommandInput, cb: (err: any, data?: ListHypervisorsCommandOutput) => void): void;
128
142
  listHypervisors(args: ListHypervisorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHypervisorsCommandOutput) => void): void;
129
143
  /**
144
+ * @public
130
145
  * <p>Lists the tags applied to the resource identified by its Amazon Resource Name
131
146
  * (ARN).</p>
132
147
  */
@@ -134,12 +149,14 @@ export declare class BackupGateway extends BackupGatewayClient {
134
149
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
135
150
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
136
151
  /**
152
+ * @public
137
153
  * <p>Lists your virtual machines.</p>
138
154
  */
139
155
  listVirtualMachines(args: ListVirtualMachinesCommandInput, options?: __HttpHandlerOptions): Promise<ListVirtualMachinesCommandOutput>;
140
156
  listVirtualMachines(args: ListVirtualMachinesCommandInput, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void): void;
141
157
  listVirtualMachines(args: ListVirtualMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void): void;
142
158
  /**
159
+ * @public
143
160
  * <p>This action sets the bandwidth rate limit schedule for a specified gateway.
144
161
  * By default, gateways do not have a bandwidth rate limit schedule, which means
145
162
  * no bandwidth rate limiting is in effect. Use this to initiate a
@@ -149,6 +166,7 @@ export declare class BackupGateway extends BackupGatewayClient {
149
166
  putBandwidthRateLimitSchedule(args: PutBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void): void;
150
167
  putBandwidthRateLimitSchedule(args: PutBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void): void;
151
168
  /**
169
+ * @public
152
170
  * <p>This action sets the property mappings for the specified hypervisor.
153
171
  * A hypervisor property mapping displays the relationship of entity properties
154
172
  * available from the on-premises hypervisor to the properties available in Amazon Web Services.</p>
@@ -157,24 +175,28 @@ export declare class BackupGateway extends BackupGatewayClient {
157
175
  putHypervisorPropertyMappings(args: PutHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void): void;
158
176
  putHypervisorPropertyMappings(args: PutHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void): void;
159
177
  /**
178
+ * @public
160
179
  * <p>Set the maintenance start time for a gateway.</p>
161
180
  */
162
181
  putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions): Promise<PutMaintenanceStartTimeCommandOutput>;
163
182
  putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void): void;
164
183
  putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void): void;
165
184
  /**
185
+ * @public
166
186
  * <p>This action sends a request to sync metadata across the specified virtual machines.</p>
167
187
  */
168
188
  startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, options?: __HttpHandlerOptions): Promise<StartVirtualMachinesMetadataSyncCommandOutput>;
169
189
  startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void): void;
170
190
  startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void): void;
171
191
  /**
192
+ * @public
172
193
  * <p>Tag the resource.</p>
173
194
  */
174
195
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
175
196
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
176
197
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
177
198
  /**
199
+ * @public
178
200
  * <p>Tests your hypervisor configuration to validate that backup gateway can connect with the
179
201
  * hypervisor and its resources.</p>
180
202
  */
@@ -182,12 +204,14 @@ export declare class BackupGateway extends BackupGatewayClient {
182
204
  testHypervisorConfiguration(args: TestHypervisorConfigurationCommandInput, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void): void;
183
205
  testHypervisorConfiguration(args: TestHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void): void;
184
206
  /**
207
+ * @public
185
208
  * <p>Removes tags from the resource.</p>
186
209
  */
187
210
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
188
211
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
189
212
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
190
213
  /**
214
+ * @public
191
215
  * <p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name
192
216
  * (ARN) of the gateway in your request.</p>
193
217
  */
@@ -195,6 +219,7 @@ export declare class BackupGateway extends BackupGatewayClient {
195
219
  updateGatewayInformation(args: UpdateGatewayInformationCommandInput, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
196
220
  updateGatewayInformation(args: UpdateGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
197
221
  /**
222
+ * @public
198
223
  * <p>Updates the gateway virtual machine (VM) software.
199
224
  * The request immediately triggers the software update.</p>
200
225
  * <note>
@@ -207,6 +232,7 @@ export declare class BackupGateway extends BackupGatewayClient {
207
232
  updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
208
233
  updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
209
234
  /**
235
+ * @public
210
236
  * <p>Updates a hypervisor metadata, including its host, username, and password. Specify which
211
237
  * hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your
212
238
  * request.</p>
@@ -33,15 +33,24 @@ import { UpdateGatewayInformationCommandInput, UpdateGatewayInformationCommandOu
33
33
  import { UpdateGatewaySoftwareNowCommandInput, UpdateGatewaySoftwareNowCommandOutput } from "./commands/UpdateGatewaySoftwareNowCommand";
34
34
  import { UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput } from "./commands/UpdateHypervisorCommand";
35
35
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
36
+ /**
37
+ * @public
38
+ */
36
39
  export type ServiceInputTypes = AssociateGatewayToServerCommandInput | CreateGatewayCommandInput | DeleteGatewayCommandInput | DeleteHypervisorCommandInput | DisassociateGatewayFromServerCommandInput | GetBandwidthRateLimitScheduleCommandInput | GetGatewayCommandInput | GetHypervisorCommandInput | GetHypervisorPropertyMappingsCommandInput | GetVirtualMachineCommandInput | ImportHypervisorConfigurationCommandInput | ListGatewaysCommandInput | ListHypervisorsCommandInput | ListTagsForResourceCommandInput | ListVirtualMachinesCommandInput | PutBandwidthRateLimitScheduleCommandInput | PutHypervisorPropertyMappingsCommandInput | PutMaintenanceStartTimeCommandInput | StartVirtualMachinesMetadataSyncCommandInput | TagResourceCommandInput | TestHypervisorConfigurationCommandInput | UntagResourceCommandInput | UpdateGatewayInformationCommandInput | UpdateGatewaySoftwareNowCommandInput | UpdateHypervisorCommandInput;
40
+ /**
41
+ * @public
42
+ */
37
43
  export type ServiceOutputTypes = AssociateGatewayToServerCommandOutput | CreateGatewayCommandOutput | DeleteGatewayCommandOutput | DeleteHypervisorCommandOutput | DisassociateGatewayFromServerCommandOutput | GetBandwidthRateLimitScheduleCommandOutput | GetGatewayCommandOutput | GetHypervisorCommandOutput | GetHypervisorPropertyMappingsCommandOutput | GetVirtualMachineCommandOutput | ImportHypervisorConfigurationCommandOutput | ListGatewaysCommandOutput | ListHypervisorsCommandOutput | ListTagsForResourceCommandOutput | ListVirtualMachinesCommandOutput | PutBandwidthRateLimitScheduleCommandOutput | PutHypervisorPropertyMappingsCommandOutput | PutMaintenanceStartTimeCommandOutput | StartVirtualMachinesMetadataSyncCommandOutput | TagResourceCommandOutput | TestHypervisorConfigurationCommandOutput | UntagResourceCommandOutput | UpdateGatewayInformationCommandOutput | UpdateGatewaySoftwareNowCommandOutput | UpdateHypervisorCommandOutput;
44
+ /**
45
+ * @public
46
+ */
38
47
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
39
48
  /**
40
49
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
41
50
  */
42
51
  requestHandler?: __HttpHandler;
43
52
  /**
44
- * A constructor for a class implementing the {@link __Checksum} interface
53
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
45
54
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
46
55
  * @internal
47
56
  */
@@ -131,23 +140,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
131
140
  */
132
141
  logger?: __Logger;
133
142
  /**
134
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
143
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
135
144
  */
136
145
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
137
146
  }
147
+ /**
148
+ * @public
149
+ */
138
150
  type BackupGatewayClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
139
151
  /**
140
- * The configuration interface of BackupGatewayClient class constructor that set the region, credentials and other options.
152
+ * @public
153
+ *
154
+ * The configuration interface of BackupGatewayClient class constructor that set the region, credentials and other options.
141
155
  */
142
156
  export interface BackupGatewayClientConfig extends BackupGatewayClientConfigType {
143
157
  }
158
+ /**
159
+ * @public
160
+ */
144
161
  type BackupGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
145
162
  /**
146
- * The resolved configuration interface of BackupGatewayClient class. This is resolved and normalized from the {@link BackupGatewayClientConfig | constructor configuration interface}.
163
+ * @public
164
+ *
165
+ * The resolved configuration interface of BackupGatewayClient class. This is resolved and normalized from the {@link BackupGatewayClientConfig | constructor configuration interface}.
147
166
  */
148
167
  export interface BackupGatewayClientResolvedConfig extends BackupGatewayClientResolvedConfigType {
149
168
  }
150
169
  /**
170
+ * @public
151
171
  * <fullname>Backup gateway</fullname>
152
172
  * <p>Backup gateway connects Backup to your hypervisor, so you can
153
173
  * create, store, and restore backups of your virtual machines (VMs) anywhere, whether
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { AssociateGatewayToServerInput, AssociateGatewayToServerOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateGatewayToServerCommand}.
8
10
  */
9
11
  export interface AssociateGatewayToServerCommandInput extends AssociateGatewayToServerInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateGatewayToServerCommand}.
13
17
  */
14
18
  export interface AssociateGatewayToServerCommandOutput extends AssociateGatewayToServerOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Associates a backup gateway with your server. After you complete the association process,
18
23
  * you can back up and restore your VMs through the gateway.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AssociateGatewayToServerCommandOutput extends AssociateGatewayT
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AssociateGatewayToServerCommandInput - {@link AssociateGatewayToServerCommandInput}
35
+ * @returns {@link AssociateGatewayToServerCommandOutput}
29
36
  * @see {@link AssociateGatewayToServerCommandInput} for command's `input` shape.
30
37
  * @see {@link AssociateGatewayToServerCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -48,11 +55,20 @@ export interface AssociateGatewayToServerCommandOutput extends AssociateGatewayT
48
55
  export declare class AssociateGatewayToServerCommand extends $Command<AssociateGatewayToServerCommandInput, AssociateGatewayToServerCommandOutput, BackupGatewayClientResolvedConfig> {
49
56
  readonly input: AssociateGatewayToServerCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: AssociateGatewayToServerCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateGatewayToServerCommandInput, AssociateGatewayToServerCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { CreateGatewayInput, CreateGatewayOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGatewayCommand}.
8
10
  */
9
11
  export interface CreateGatewayCommandInput extends CreateGatewayInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGatewayCommand}.
13
17
  */
14
18
  export interface CreateGatewayCommandOutput extends CreateGatewayOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a backup gateway. After you create a gateway, you can associate it with a server
18
23
  * using the <code>AssociateGatewayToServer</code> operation.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateGatewayCommandOutput extends CreateGatewayOutput, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateGatewayCommandInput - {@link CreateGatewayCommandInput}
35
+ * @returns {@link CreateGatewayCommandOutput}
29
36
  * @see {@link CreateGatewayCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateGatewayCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -45,11 +52,20 @@ export interface CreateGatewayCommandOutput extends CreateGatewayOutput, __Metad
45
52
  export declare class CreateGatewayCommand extends $Command<CreateGatewayCommandInput, CreateGatewayCommandOutput, BackupGatewayClientResolvedConfig> {
46
53
  readonly input: CreateGatewayCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: CreateGatewayCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGatewayCommandInput, CreateGatewayCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { DeleteGatewayInput, DeleteGatewayOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGatewayCommand}.
8
10
  */
9
11
  export interface DeleteGatewayCommandInput extends DeleteGatewayInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGatewayCommand}.
13
17
  */
14
18
  export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a backup gateway.</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 DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteGatewayCommandInput - {@link DeleteGatewayCommandInput}
34
+ * @returns {@link DeleteGatewayCommandOutput}
28
35
  * @see {@link DeleteGatewayCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteGatewayCommandOutput} for command's `response` shape.
30
37
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
47
54
  export declare class DeleteGatewayCommand extends $Command<DeleteGatewayCommandInput, DeleteGatewayCommandOutput, BackupGatewayClientResolvedConfig> {
48
55
  readonly input: DeleteGatewayCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteGatewayCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGatewayCommandInput, DeleteGatewayCommandOutput>;
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 { DeleteHypervisorInput, DeleteHypervisorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteHypervisorCommand}.
8
10
  */
9
11
  export interface DeleteHypervisorCommandInput extends DeleteHypervisorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteHypervisorCommand}.
13
17
  */
14
18
  export interface DeleteHypervisorCommandOutput extends DeleteHypervisorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a hypervisor.</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 DeleteHypervisorCommandOutput extends DeleteHypervisorOutput, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteHypervisorCommandInput - {@link DeleteHypervisorCommandInput}
34
+ * @returns {@link DeleteHypervisorCommandOutput}
28
35
  * @see {@link DeleteHypervisorCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteHypervisorCommandOutput} for command's `response` shape.
30
37
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteHypervisorCommandOutput extends DeleteHypervisorOutput, _
53
60
  export declare class DeleteHypervisorCommand extends $Command<DeleteHypervisorCommandInput, DeleteHypervisorCommandOutput, BackupGatewayClientResolvedConfig> {
54
61
  readonly input: DeleteHypervisorCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeleteHypervisorCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteHypervisorCommandInput, DeleteHypervisorCommandOutput>;
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 { DisassociateGatewayFromServerInput, DisassociateGatewayFromServerOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateGatewayFromServerCommand}.
8
10
  */
9
11
  export interface DisassociateGatewayFromServerCommandInput extends DisassociateGatewayFromServerInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateGatewayFromServerCommand}.
13
17
  */
14
18
  export interface DisassociateGatewayFromServerCommandOutput extends DisassociateGatewayFromServerOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disassociates a backup gateway from the specified server. After the disassociation process
18
23
  * finishes, the gateway can no longer access the virtual machines on the server.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DisassociateGatewayFromServerCommandOutput extends Disassociate
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DisassociateGatewayFromServerCommandInput - {@link DisassociateGatewayFromServerCommandInput}
35
+ * @returns {@link DisassociateGatewayFromServerCommandOutput}
29
36
  * @see {@link DisassociateGatewayFromServerCommandInput} for command's `input` shape.
30
37
  * @see {@link DisassociateGatewayFromServerCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DisassociateGatewayFromServerCommandOutput extends Disassociate
51
58
  export declare class DisassociateGatewayFromServerCommand extends $Command<DisassociateGatewayFromServerCommandInput, DisassociateGatewayFromServerCommandOutput, BackupGatewayClientResolvedConfig> {
52
59
  readonly input: DisassociateGatewayFromServerCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DisassociateGatewayFromServerCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateGatewayFromServerCommandInput, DisassociateGatewayFromServerCommandOutput>;
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 { GetBandwidthRateLimitScheduleInput, GetBandwidthRateLimitScheduleOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBandwidthRateLimitScheduleCommand}.
8
10
  */
9
11
  export interface GetBandwidthRateLimitScheduleCommandInput extends GetBandwidthRateLimitScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBandwidthRateLimitScheduleCommand}.
13
17
  */
14
18
  export interface GetBandwidthRateLimitScheduleCommandOutput extends GetBandwidthRateLimitScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the bandwidth rate limit schedule for a specified gateway.
18
23
  * By default, gateways do not have bandwidth rate limit schedules, which means
19
24
  * no bandwidth rate limiting is in effect. Use this to get a gateway's
@@ -28,6 +33,8 @@ export interface GetBandwidthRateLimitScheduleCommandOutput extends GetBandwidth
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetBandwidthRateLimitScheduleCommandInput - {@link GetBandwidthRateLimitScheduleCommandInput}
37
+ * @returns {@link GetBandwidthRateLimitScheduleCommandOutput}
31
38
  * @see {@link GetBandwidthRateLimitScheduleCommandInput} for command's `input` shape.
32
39
  * @see {@link GetBandwidthRateLimitScheduleCommandOutput} for command's `response` shape.
33
40
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetBandwidthRateLimitScheduleCommandOutput extends GetBandwidth
50
57
  export declare class GetBandwidthRateLimitScheduleCommand extends $Command<GetBandwidthRateLimitScheduleCommandInput, GetBandwidthRateLimitScheduleCommandOutput, BackupGatewayClientResolvedConfig> {
51
58
  readonly input: GetBandwidthRateLimitScheduleCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetBandwidthRateLimitScheduleCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBandwidthRateLimitScheduleCommandInput, GetBandwidthRateLimitScheduleCommandOutput>;
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 { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
5
5
  import { GetGatewayInput, GetGatewayOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetGatewayCommand}.
8
10
  */
9
11
  export interface GetGatewayCommandInput extends GetGatewayInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetGatewayCommand}.
13
17
  */
14
18
  export interface GetGatewayCommandOutput extends GetGatewayOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>By providing the ARN (Amazon Resource Name), this
18
23
  * API returns the gateway.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetGatewayCommandOutput extends GetGatewayOutput, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetGatewayCommandInput - {@link GetGatewayCommandInput}
35
+ * @returns {@link GetGatewayCommandOutput}
29
36
  * @see {@link GetGatewayCommandInput} for command's `input` shape.
30
37
  * @see {@link GetGatewayCommandOutput} for command's `response` shape.
31
38
  * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetGatewayCommandOutput extends GetGatewayOutput, __MetadataBea
48
55
  export declare class GetGatewayCommand extends $Command<GetGatewayCommandInput, GetGatewayCommandOutput, BackupGatewayClientResolvedConfig> {
49
56
  readonly input: GetGatewayCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetGatewayCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGatewayCommandInput, GetGatewayCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }