@scaleway/sdk-instance 1.0.2

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.
@@ -0,0 +1,507 @@
1
+ import { API as ParentAPI } from '@scaleway/sdk-client';
2
+ import type { Zone as ScwZone } from '@scaleway/sdk-client';
3
+ import type { ApplyBlockMigrationRequest, AttachServerFileSystemRequest, AttachServerFileSystemResponse, AttachServerVolumeRequest, AttachServerVolumeResponse, CheckBlockMigrationOrganizationQuotasRequest, CreateImageRequest, CreateImageResponse, CreateIpRequest, CreateIpResponse, CreatePlacementGroupRequest, CreatePlacementGroupResponse, CreatePrivateNICRequest, CreatePrivateNICResponse, CreateSecurityGroupRequest, CreateSecurityGroupResponse, CreateSecurityGroupRuleRequest, CreateSecurityGroupRuleResponse, CreateServerRequest, CreateServerResponse, CreateSnapshotRequest, CreateSnapshotResponse, CreateVolumeRequest, CreateVolumeResponse, DeleteImageRequest, DeleteIpRequest, DeletePlacementGroupRequest, DeletePrivateNICRequest, DeleteSecurityGroupRequest, DeleteSecurityGroupRuleRequest, DeleteServerRequest, DeleteServerUserDataRequest, DeleteSnapshotRequest, DeleteVolumeRequest, DetachServerFileSystemRequest, DetachServerFileSystemResponse, DetachServerVolumeRequest, DetachServerVolumeResponse, ExportSnapshotRequest, ExportSnapshotResponse, GetDashboardRequest, GetDashboardResponse, GetImageRequest, GetImageResponse, GetIpRequest, GetIpResponse, GetPlacementGroupRequest, GetPlacementGroupResponse, GetPlacementGroupServersRequest, GetPlacementGroupServersResponse, GetPrivateNICRequest, GetPrivateNICResponse, GetSecurityGroupRequest, GetSecurityGroupResponse, GetSecurityGroupRuleRequest, GetSecurityGroupRuleResponse, GetServerCompatibleTypesRequest, GetServerRequest, GetServerResponse, GetServerTypesAvailabilityRequest, GetServerTypesAvailabilityResponse, GetSnapshotRequest, GetSnapshotResponse, GetVolumeRequest, GetVolumeResponse, ListDefaultSecurityGroupRulesRequest, ListImagesRequest, ListImagesResponse, ListIpsRequest, ListIpsResponse, ListPlacementGroupsRequest, ListPlacementGroupsResponse, ListPrivateNICsRequest, ListPrivateNICsResponse, ListSecurityGroupRulesRequest, ListSecurityGroupRulesResponse, ListSecurityGroupsRequest, ListSecurityGroupsResponse, ListServerActionsRequest, ListServerActionsResponse, ListServerUserDataRequest, ListServerUserDataResponse, ListServersRequest, ListServersResponse, ListServersTypesRequest, ListServersTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListVolumesRequest, ListVolumesResponse, ListVolumesTypesRequest, ListVolumesTypesResponse, MigrationPlan, PlanBlockMigrationRequest, PrivateNIC, ServerActionRequest, ServerActionResponse, ServerCompatibleTypes, SetImageRequest, SetPlacementGroupRequest, SetPlacementGroupResponse, SetPlacementGroupServersRequest, SetPlacementGroupServersResponse, SetSecurityGroupRulesRequest, SetSecurityGroupRulesResponse, UpdateImageRequest, UpdateImageResponse, UpdateIpRequest, UpdateIpResponse, UpdatePlacementGroupRequest, UpdatePlacementGroupResponse, UpdatePlacementGroupServersRequest, UpdatePlacementGroupServersResponse, UpdatePrivateNICRequest, UpdateSecurityGroupRequest, UpdateSecurityGroupResponse, UpdateSecurityGroupRuleRequest, UpdateSecurityGroupRuleResponse, UpdateServerRequest, UpdateServerResponse, UpdateSnapshotRequest, UpdateSnapshotResponse, UpdateVolumeRequest, UpdateVolumeResponse } from './types.gen';
4
+ import type { SetImageResponse, SetSecurityGroupRequest, SetSecurityGroupResponse, SetSecurityGroupRuleRequest, SetSecurityGroupRuleResponse, SetServerRequest, SetServerResponse, SetSnapshotRequest, SetSnapshotResponse } from './types.private.gen';
5
+ /**
6
+ * Instance API.
7
+
8
+ This API allows you to manage your CPU and GPU Instances.
9
+ */
10
+ export declare class API extends ParentAPI {
11
+ /** Lists the available zones of the API. */
12
+ static readonly LOCALITIES: ScwZone[];
13
+ /**
14
+ * Get availability. Get availability for all Instance types.
15
+ *
16
+ * @param request - The request {@link GetServerTypesAvailabilityRequest}
17
+ * @returns A Promise of GetServerTypesAvailabilityResponse
18
+ */
19
+ getServerTypesAvailability: (request?: Readonly<GetServerTypesAvailabilityRequest>) => Promise<GetServerTypesAvailabilityResponse>;
20
+ /**
21
+ * List Instance types. List available Instance types and their technical details.
22
+ *
23
+ * @param request - The request {@link ListServersTypesRequest}
24
+ * @returns A Promise of ListServersTypesResponse
25
+ */
26
+ listServersTypes: (request?: Readonly<ListServersTypesRequest>) => Promise<ListServersTypesResponse>;
27
+ /**
28
+ * List volume types. List all volume types and their technical details.
29
+ *
30
+ * @param request - The request {@link ListVolumesTypesRequest}
31
+ * @returns A Promise of ListVolumesTypesResponse
32
+ */
33
+ listVolumesTypes: (request?: Readonly<ListVolumesTypesRequest>) => Promise<ListVolumesTypesResponse>;
34
+ protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
35
+ /**
36
+ * List all Instances. List all Instances in a specified Availability Zone, e.g. `fr-par-1`.
37
+ *
38
+ * @param request - The request {@link ListServersRequest}
39
+ * @returns A Promise of ListServersResponse
40
+ */
41
+ listServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse> & {
42
+ all: () => Promise<import("./types.gen").Server[]>;
43
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Server[], void, void>;
44
+ };
45
+ protected _createServer: (request: Readonly<CreateServerRequest>) => Promise<CreateServerResponse>;
46
+ /**
47
+ * Delete an Instance. Delete the Instance with the specified ID.
48
+ *
49
+ * @param request - The request {@link DeleteServerRequest}
50
+ */
51
+ deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<void>;
52
+ /**
53
+ * Get an Instance. Get the details of a specified Instance.
54
+ *
55
+ * @param request - The request {@link GetServerRequest}
56
+ * @returns A Promise of GetServerResponse
57
+ */
58
+ getServer: (request: Readonly<GetServerRequest>) => Promise<GetServerResponse>;
59
+ protected _setServer: (request: Readonly<SetServerRequest>) => Promise<SetServerResponse>;
60
+ protected _updateServer: (request: Readonly<UpdateServerRequest>) => Promise<UpdateServerResponse>;
61
+ /**
62
+ * List Instance actions. List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance.
63
+ *
64
+ * @param request - The request {@link ListServerActionsRequest}
65
+ * @returns A Promise of ListServerActionsResponse
66
+ */
67
+ listServerActions: (request: Readonly<ListServerActionsRequest>) => Promise<ListServerActionsResponse>;
68
+ /**
69
+ * Perform action. Perform an action on an Instance.
70
+ Available actions are:
71
+ * `poweron`: Start a stopped Instance.
72
+ * `poweroff`: Fully stop the Instance and release the hypervisor slot.
73
+ * `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
74
+ * `reboot`: Stop the instance and restart it.
75
+ * `backup`: Create an image with all the volumes of an Instance.
76
+ * `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
77
+ * `enable_routed_ip`: Migrate the Instance to the new network stack.
78
+
79
+ The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
80
+ If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
81
+
82
+ The `backup` action can be done with:
83
+ * No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
84
+ * `volumes` key in the body with a dictionary as value, in this dictionary volumes UUID as keys and empty dictionaries as values : an image is created with the snapshots of the volumes in `volumes` key. `scratch` volumes types can't be shapshotted.
85
+ *
86
+ * @param request - The request {@link ServerActionRequest}
87
+ * @returns A Promise of ServerActionResponse
88
+ */
89
+ serverAction: (request: Readonly<ServerActionRequest>) => Promise<ServerActionResponse>;
90
+ /**
91
+ * List user data. List all user data keys registered on a specified Instance.
92
+ *
93
+ * @param request - The request {@link ListServerUserDataRequest}
94
+ * @returns A Promise of ListServerUserDataResponse
95
+ */
96
+ listServerUserData: (request: Readonly<ListServerUserDataRequest>) => Promise<ListServerUserDataResponse>;
97
+ /**
98
+ * Delete user data. Delete the specified key from an Instance's user data.
99
+ *
100
+ * @param request - The request {@link DeleteServerUserDataRequest}
101
+ */
102
+ deleteServerUserData: (request: Readonly<DeleteServerUserDataRequest>) => Promise<void>;
103
+ /**
104
+ * Get Instance compatible types. Get compatible commercial types that can be used to update the Instance. The compatibility of an Instance offer is based on:
105
+ * the CPU architecture
106
+ * the OS type
107
+ * the required l_ssd storage size
108
+ * the required scratch storage size
109
+ If the specified Instance offer is flagged as end of service, the best compatible offer is the first returned.
110
+ *
111
+ * @param request - The request {@link GetServerCompatibleTypesRequest}
112
+ * @returns A Promise of ServerCompatibleTypes
113
+ */
114
+ getServerCompatibleTypes: (request: Readonly<GetServerCompatibleTypesRequest>) => Promise<ServerCompatibleTypes>;
115
+ attachServerVolume: (request: Readonly<AttachServerVolumeRequest>) => Promise<AttachServerVolumeResponse>;
116
+ detachServerVolume: (request: Readonly<DetachServerVolumeRequest>) => Promise<DetachServerVolumeResponse>;
117
+ /**
118
+ * Attach a filesystem volume to an Instance.
119
+ *
120
+ * @param request - The request {@link AttachServerFileSystemRequest}
121
+ * @returns A Promise of AttachServerFileSystemResponse
122
+ */
123
+ attachServerFileSystem: (request: Readonly<AttachServerFileSystemRequest>) => Promise<AttachServerFileSystemResponse>;
124
+ /**
125
+ * Detach a filesystem volume to an Instance.
126
+ *
127
+ * @param request - The request {@link DetachServerFileSystemRequest}
128
+ * @returns A Promise of DetachServerFileSystemResponse
129
+ */
130
+ detachServerFileSystem: (request: Readonly<DetachServerFileSystemRequest>) => Promise<DetachServerFileSystemResponse>;
131
+ protected pageOfListImages: (request?: Readonly<ListImagesRequest>) => Promise<ListImagesResponse>;
132
+ /**
133
+ * List Instance images. List all existing Instance images.
134
+ *
135
+ * @param request - The request {@link ListImagesRequest}
136
+ * @returns A Promise of ListImagesResponse
137
+ */
138
+ listImages: (request?: Readonly<ListImagesRequest>) => Promise<ListImagesResponse> & {
139
+ all: () => Promise<import("./types.gen").Image[]>;
140
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Image[], void, void>;
141
+ };
142
+ /**
143
+ * Get an Instance image. Get details of an image with the specified ID.
144
+ *
145
+ * @param request - The request {@link GetImageRequest}
146
+ * @returns A Promise of GetImageResponse
147
+ */
148
+ getImage: (request: Readonly<GetImageRequest>) => Promise<GetImageResponse>;
149
+ /**
150
+ * Create an Instance image. Create an Instance image from the specified snapshot ID.
151
+ *
152
+ * @param request - The request {@link CreateImageRequest}
153
+ * @returns A Promise of CreateImageResponse
154
+ */
155
+ createImage: (request: Readonly<CreateImageRequest>) => Promise<CreateImageResponse>;
156
+ protected _setImage: (request: Readonly<SetImageRequest>) => Promise<SetImageResponse>;
157
+ /**
158
+ * Update image. Update the properties of an image.
159
+ *
160
+ * @param request - The request {@link UpdateImageRequest}
161
+ * @returns A Promise of UpdateImageResponse
162
+ */
163
+ updateImage: (request: Readonly<UpdateImageRequest>) => Promise<UpdateImageResponse>;
164
+ /**
165
+ * Delete an Instance image. Delete the image with the specified ID.
166
+ *
167
+ * @param request - The request {@link DeleteImageRequest}
168
+ */
169
+ deleteImage: (request: Readonly<DeleteImageRequest>) => Promise<void>;
170
+ protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
171
+ /**
172
+ * List snapshots. List all snapshots of an Organization in a specified Availability Zone.
173
+ *
174
+ * @param request - The request {@link ListSnapshotsRequest}
175
+ * @returns A Promise of ListSnapshotsResponse
176
+ */
177
+ listSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse> & {
178
+ all: () => Promise<import("./types.gen").Snapshot[]>;
179
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Snapshot[], void, void>;
180
+ };
181
+ /**
182
+ * Create a snapshot from a specified volume or from a QCOW2 file. Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.
183
+ *
184
+ * @param request - The request {@link CreateSnapshotRequest}
185
+ * @returns A Promise of CreateSnapshotResponse
186
+ */
187
+ createSnapshot: (request?: Readonly<CreateSnapshotRequest>) => Promise<CreateSnapshotResponse>;
188
+ /**
189
+ * Get a snapshot. Get details of a snapshot with the specified ID.
190
+ *
191
+ * @param request - The request {@link GetSnapshotRequest}
192
+ * @returns A Promise of GetSnapshotResponse
193
+ */
194
+ getSnapshot: (request: Readonly<GetSnapshotRequest>) => Promise<GetSnapshotResponse>;
195
+ protected _setSnapshot: (request: Readonly<SetSnapshotRequest>) => Promise<SetSnapshotResponse>;
196
+ /**
197
+ * Update a snapshot. Update the properties of a snapshot.
198
+ *
199
+ * @param request - The request {@link UpdateSnapshotRequest}
200
+ * @returns A Promise of UpdateSnapshotResponse
201
+ */
202
+ updateSnapshot: (request: Readonly<UpdateSnapshotRequest>) => Promise<UpdateSnapshotResponse>;
203
+ /**
204
+ * Delete a snapshot. Delete the snapshot with the specified ID.
205
+ *
206
+ * @param request - The request {@link DeleteSnapshotRequest}
207
+ */
208
+ deleteSnapshot: (request: Readonly<DeleteSnapshotRequest>) => Promise<void>;
209
+ /**
210
+ * Export a snapshot. Export a snapshot to a specified Object Storage bucket in the same region.
211
+ *
212
+ * @param request - The request {@link ExportSnapshotRequest}
213
+ * @returns A Promise of ExportSnapshotResponse
214
+ */
215
+ exportSnapshot: (request: Readonly<ExportSnapshotRequest>) => Promise<ExportSnapshotResponse>;
216
+ protected pageOfListVolumes: (request?: Readonly<ListVolumesRequest>) => Promise<ListVolumesResponse>;
217
+ /**
218
+ * List volumes. List volumes in the specified Availability Zone. You can filter the output by volume type.
219
+ *
220
+ * @param request - The request {@link ListVolumesRequest}
221
+ * @returns A Promise of ListVolumesResponse
222
+ */
223
+ listVolumes: (request?: Readonly<ListVolumesRequest>) => Promise<ListVolumesResponse> & {
224
+ all: () => Promise<import("./types.gen").Volume[]>;
225
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Volume[], void, void>;
226
+ };
227
+ /**
228
+ * Create a volume. Create a volume of a specified type in an Availability Zone.
229
+ *
230
+ * @param request - The request {@link CreateVolumeRequest}
231
+ * @returns A Promise of CreateVolumeResponse
232
+ */
233
+ createVolume: (request?: Readonly<CreateVolumeRequest>) => Promise<CreateVolumeResponse>;
234
+ /**
235
+ * Get a volume. Get details of a volume with the specified ID.
236
+ *
237
+ * @param request - The request {@link GetVolumeRequest}
238
+ * @returns A Promise of GetVolumeResponse
239
+ */
240
+ getVolume: (request: Readonly<GetVolumeRequest>) => Promise<GetVolumeResponse>;
241
+ /**
242
+ * Update a volume. Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
243
+ *
244
+ * @param request - The request {@link UpdateVolumeRequest}
245
+ * @returns A Promise of UpdateVolumeResponse
246
+ */
247
+ updateVolume: (request: Readonly<UpdateVolumeRequest>) => Promise<UpdateVolumeResponse>;
248
+ /**
249
+ * Delete a volume. Delete the volume with the specified ID.
250
+ *
251
+ * @param request - The request {@link DeleteVolumeRequest}
252
+ */
253
+ deleteVolume: (request: Readonly<DeleteVolumeRequest>) => Promise<void>;
254
+ protected pageOfListSecurityGroups: (request?: Readonly<ListSecurityGroupsRequest>) => Promise<ListSecurityGroupsResponse>;
255
+ /**
256
+ * List security groups. List all existing security groups.
257
+ *
258
+ * @param request - The request {@link ListSecurityGroupsRequest}
259
+ * @returns A Promise of ListSecurityGroupsResponse
260
+ */
261
+ listSecurityGroups: (request?: Readonly<ListSecurityGroupsRequest>) => Promise<ListSecurityGroupsResponse> & {
262
+ all: () => Promise<import("./types.gen").SecurityGroup[]>;
263
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SecurityGroup[], void, void>;
264
+ };
265
+ /**
266
+ * Create a security group. Create a security group with a specified name and description.
267
+ *
268
+ * @param request - The request {@link CreateSecurityGroupRequest}
269
+ * @returns A Promise of CreateSecurityGroupResponse
270
+ */
271
+ createSecurityGroup: (request: Readonly<CreateSecurityGroupRequest>) => Promise<CreateSecurityGroupResponse>;
272
+ /**
273
+ * Get a security group. Get the details of a security group with the specified ID.
274
+ *
275
+ * @param request - The request {@link GetSecurityGroupRequest}
276
+ * @returns A Promise of GetSecurityGroupResponse
277
+ */
278
+ getSecurityGroup: (request: Readonly<GetSecurityGroupRequest>) => Promise<GetSecurityGroupResponse>;
279
+ /**
280
+ * Delete a security group. Delete a security group with the specified ID.
281
+ *
282
+ * @param request - The request {@link DeleteSecurityGroupRequest}
283
+ */
284
+ deleteSecurityGroup: (request: Readonly<DeleteSecurityGroupRequest>) => Promise<void>;
285
+ protected _setSecurityGroup: (request: Readonly<SetSecurityGroupRequest>) => Promise<SetSecurityGroupResponse>;
286
+ /**
287
+ * Update a security group. Update the properties of security group.
288
+ *
289
+ * @param request - The request {@link UpdateSecurityGroupRequest}
290
+ * @returns A Promise of UpdateSecurityGroupResponse
291
+ */
292
+ updateSecurityGroup: (request: Readonly<UpdateSecurityGroupRequest>) => Promise<UpdateSecurityGroupResponse>;
293
+ /**
294
+ * Get default rules. Lists the default rules applied to all the security groups.
295
+ *
296
+ * @param request - The request {@link ListDefaultSecurityGroupRulesRequest}
297
+ * @returns A Promise of ListSecurityGroupRulesResponse
298
+ */
299
+ listDefaultSecurityGroupRules: (request?: Readonly<ListDefaultSecurityGroupRulesRequest>) => Promise<ListSecurityGroupRulesResponse>;
300
+ protected pageOfListSecurityGroupRules: (request: Readonly<ListSecurityGroupRulesRequest>) => Promise<ListSecurityGroupRulesResponse>;
301
+ /**
302
+ * List rules. List the rules of the a specified security group ID.
303
+ *
304
+ * @param request - The request {@link ListSecurityGroupRulesRequest}
305
+ * @returns A Promise of ListSecurityGroupRulesResponse
306
+ */
307
+ listSecurityGroupRules: (request: Readonly<ListSecurityGroupRulesRequest>) => Promise<ListSecurityGroupRulesResponse> & {
308
+ all: () => Promise<import("./types.gen").SecurityGroupRule[]>;
309
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SecurityGroupRule[], void, void>;
310
+ };
311
+ /**
312
+ * Create rule. Create a rule in the specified security group ID.
313
+ *
314
+ * @param request - The request {@link CreateSecurityGroupRuleRequest}
315
+ * @returns A Promise of CreateSecurityGroupRuleResponse
316
+ */
317
+ createSecurityGroupRule: (request: Readonly<CreateSecurityGroupRuleRequest>) => Promise<CreateSecurityGroupRuleResponse>;
318
+ /**
319
+ * Update all the rules of a security group. Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.
320
+ *
321
+ * @param request - The request {@link SetSecurityGroupRulesRequest}
322
+ * @returns A Promise of SetSecurityGroupRulesResponse
323
+ */
324
+ setSecurityGroupRules: (request: Readonly<SetSecurityGroupRulesRequest>) => Promise<SetSecurityGroupRulesResponse>;
325
+ /**
326
+ * Delete rule. Delete a security group rule with the specified ID.
327
+ *
328
+ * @param request - The request {@link DeleteSecurityGroupRuleRequest}
329
+ */
330
+ deleteSecurityGroupRule: (request: Readonly<DeleteSecurityGroupRuleRequest>) => Promise<void>;
331
+ /**
332
+ * Get rule. Get details of a security group rule with the specified ID.
333
+ *
334
+ * @param request - The request {@link GetSecurityGroupRuleRequest}
335
+ * @returns A Promise of GetSecurityGroupRuleResponse
336
+ */
337
+ getSecurityGroupRule: (request: Readonly<GetSecurityGroupRuleRequest>) => Promise<GetSecurityGroupRuleResponse>;
338
+ protected _setSecurityGroupRule: (request: Readonly<SetSecurityGroupRuleRequest>) => Promise<SetSecurityGroupRuleResponse>;
339
+ /**
340
+ * Update security group rule. Update the properties of a rule from a specified security group.
341
+ *
342
+ * @param request - The request {@link UpdateSecurityGroupRuleRequest}
343
+ * @returns A Promise of UpdateSecurityGroupRuleResponse
344
+ */
345
+ updateSecurityGroupRule: (request: Readonly<UpdateSecurityGroupRuleRequest>) => Promise<UpdateSecurityGroupRuleResponse>;
346
+ protected pageOfListPlacementGroups: (request?: Readonly<ListPlacementGroupsRequest>) => Promise<ListPlacementGroupsResponse>;
347
+ /**
348
+ * List placement groups. List all placement groups in a specified Availability Zone.
349
+ *
350
+ * @param request - The request {@link ListPlacementGroupsRequest}
351
+ * @returns A Promise of ListPlacementGroupsResponse
352
+ */
353
+ listPlacementGroups: (request?: Readonly<ListPlacementGroupsRequest>) => Promise<ListPlacementGroupsResponse> & {
354
+ all: () => Promise<import("./types.gen").PlacementGroup[]>;
355
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").PlacementGroup[], void, void>;
356
+ };
357
+ /**
358
+ * Create a placement group. Create a new placement group in a specified Availability Zone.
359
+ *
360
+ * @param request - The request {@link CreatePlacementGroupRequest}
361
+ * @returns A Promise of CreatePlacementGroupResponse
362
+ */
363
+ createPlacementGroup: (request?: Readonly<CreatePlacementGroupRequest>) => Promise<CreatePlacementGroupResponse>;
364
+ /**
365
+ * Get a placement group. Get the specified placement group.
366
+ *
367
+ * @param request - The request {@link GetPlacementGroupRequest}
368
+ * @returns A Promise of GetPlacementGroupResponse
369
+ */
370
+ getPlacementGroup: (request: Readonly<GetPlacementGroupRequest>) => Promise<GetPlacementGroupResponse>;
371
+ /**
372
+ * Set placement group. Set all parameters of the specified placement group.
373
+ *
374
+ * @param request - The request {@link SetPlacementGroupRequest}
375
+ * @returns A Promise of SetPlacementGroupResponse
376
+ */
377
+ setPlacementGroup: (request: Readonly<SetPlacementGroupRequest>) => Promise<SetPlacementGroupResponse>;
378
+ /**
379
+ * Update a placement group. Update one or more parameter of the specified placement group.
380
+ *
381
+ * @param request - The request {@link UpdatePlacementGroupRequest}
382
+ * @returns A Promise of UpdatePlacementGroupResponse
383
+ */
384
+ updatePlacementGroup: (request: Readonly<UpdatePlacementGroupRequest>) => Promise<UpdatePlacementGroupResponse>;
385
+ /**
386
+ * Delete the specified placement group.
387
+ *
388
+ * @param request - The request {@link DeletePlacementGroupRequest}
389
+ */
390
+ deletePlacementGroup: (request: Readonly<DeletePlacementGroupRequest>) => Promise<void>;
391
+ /**
392
+ * Get placement group servers. Get all Instances belonging to the specified placement group.
393
+ *
394
+ * @param request - The request {@link GetPlacementGroupServersRequest}
395
+ * @returns A Promise of GetPlacementGroupServersResponse
396
+ */
397
+ getPlacementGroupServers: (request: Readonly<GetPlacementGroupServersRequest>) => Promise<GetPlacementGroupServersResponse>;
398
+ /**
399
+ * Set placement group servers. Set all Instances belonging to the specified placement group.
400
+ *
401
+ * @param request - The request {@link SetPlacementGroupServersRequest}
402
+ * @returns A Promise of SetPlacementGroupServersResponse
403
+ */
404
+ setPlacementGroupServers: (request: Readonly<SetPlacementGroupServersRequest>) => Promise<SetPlacementGroupServersResponse>;
405
+ /**
406
+ * Update placement group servers. Update all Instances belonging to the specified placement group.
407
+ *
408
+ * @param request - The request {@link UpdatePlacementGroupServersRequest}
409
+ * @returns A Promise of UpdatePlacementGroupServersResponse
410
+ */
411
+ updatePlacementGroupServers: (request: Readonly<UpdatePlacementGroupServersRequest>) => Promise<UpdatePlacementGroupServersResponse>;
412
+ protected pageOfListIps: (request?: Readonly<ListIpsRequest>) => Promise<ListIpsResponse>;
413
+ /**
414
+ * List all flexible IPs. List all flexible IPs in a specified zone.
415
+ *
416
+ * @param request - The request {@link ListIpsRequest}
417
+ * @returns A Promise of ListIpsResponse
418
+ */
419
+ listIps: (request?: Readonly<ListIpsRequest>) => Promise<ListIpsResponse> & {
420
+ all: () => Promise<import("./types.gen").Ip[]>;
421
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Ip[], void, void>;
422
+ };
423
+ /**
424
+ * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified Instance.
425
+ *
426
+ * @param request - The request {@link CreateIpRequest}
427
+ * @returns A Promise of CreateIpResponse
428
+ */
429
+ createIp: (request?: Readonly<CreateIpRequest>) => Promise<CreateIpResponse>;
430
+ /**
431
+ * Get a flexible IP. Get details of an IP with the specified ID or address.
432
+ *
433
+ * @param request - The request {@link GetIpRequest}
434
+ * @returns A Promise of GetIpResponse
435
+ */
436
+ getIp: (request: Readonly<GetIpRequest>) => Promise<GetIpResponse>;
437
+ /**
438
+ * Update a flexible IP. Update a flexible IP in the specified zone with the specified ID.
439
+ *
440
+ * @param request - The request {@link UpdateIpRequest}
441
+ * @returns A Promise of UpdateIpResponse
442
+ */
443
+ updateIp: (request: Readonly<UpdateIpRequest>) => Promise<UpdateIpResponse>;
444
+ /**
445
+ * Delete a flexible IP. Delete the IP with the specified ID.
446
+ *
447
+ * @param request - The request {@link DeleteIpRequest}
448
+ */
449
+ deleteIp: (request: Readonly<DeleteIpRequest>) => Promise<void>;
450
+ protected pageOfListPrivateNICs: (request: Readonly<ListPrivateNICsRequest>) => Promise<ListPrivateNICsResponse>;
451
+ /**
452
+ * List all private NICs. List all private NICs of a specified Instance.
453
+ *
454
+ * @param request - The request {@link ListPrivateNICsRequest}
455
+ * @returns A Promise of ListPrivateNICsResponse
456
+ */
457
+ listPrivateNICs: (request: Readonly<ListPrivateNICsRequest>) => Promise<ListPrivateNICsResponse> & {
458
+ all: () => Promise<PrivateNIC[]>;
459
+ [Symbol.asyncIterator]: () => AsyncGenerator<PrivateNIC[], void, void>;
460
+ };
461
+ /**
462
+ * Create a private NIC connecting an Instance to a Private Network.
463
+ *
464
+ * @param request - The request {@link CreatePrivateNICRequest}
465
+ * @returns A Promise of CreatePrivateNICResponse
466
+ */
467
+ createPrivateNIC: (request: Readonly<CreatePrivateNICRequest>) => Promise<CreatePrivateNICResponse>;
468
+ /**
469
+ * Get a private NIC. Get private NIC properties.
470
+ *
471
+ * @param request - The request {@link GetPrivateNICRequest}
472
+ * @returns A Promise of GetPrivateNICResponse
473
+ */
474
+ getPrivateNIC: (request: Readonly<GetPrivateNICRequest>) => Promise<GetPrivateNICResponse>;
475
+ /**
476
+ * Update a private NIC. Update one or more parameter(s) of a specified private NIC.
477
+ *
478
+ * @param request - The request {@link UpdatePrivateNICRequest}
479
+ * @returns A Promise of PrivateNIC
480
+ */
481
+ updatePrivateNIC: (request: Readonly<UpdatePrivateNICRequest>) => Promise<PrivateNIC>;
482
+ /**
483
+ * Delete a private NIC.
484
+ *
485
+ * @param request - The request {@link DeletePrivateNICRequest}
486
+ */
487
+ deletePrivateNIC: (request: Readonly<DeletePrivateNICRequest>) => Promise<void>;
488
+ getDashboard: (request?: Readonly<GetDashboardRequest>) => Promise<GetDashboardResponse>;
489
+ /**
490
+ * Get a volume or snapshot's migration plan. Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward.
491
+ The endpoint returns the resources that should be migrated together:
492
+ - the volume and any snapshots created from the volume, if the call was made to plan a volume migration.
493
+ - the base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration.
494
+ The endpoint also returns the validation_key, which must be provided to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint to confirm that all resources listed in the plan should be migrated.
495
+ *
496
+ * @param request - The request {@link PlanBlockMigrationRequest}
497
+ * @returns A Promise of MigrationPlan
498
+ */
499
+ planBlockMigration: (request?: Readonly<PlanBlockMigrationRequest>) => Promise<MigrationPlan>;
500
+ /**
501
+ * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
502
+ *
503
+ * @param request - The request {@link ApplyBlockMigrationRequest}
504
+ */
505
+ applyBlockMigration: (request: Readonly<ApplyBlockMigrationRequest>) => Promise<void>;
506
+ checkBlockMigrationOrganizationQuotas: (request?: Readonly<CheckBlockMigrationOrganizationQuotasRequest>) => Promise<void>;
507
+ }