@aws-sdk/client-storage-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 (107) hide show
  1. package/dist-types/StorageGateway.d.ts +91 -0
  2. package/dist-types/StorageGatewayClient.d.ts +24 -4
  3. package/dist-types/commands/ActivateGatewayCommand.d.ts +16 -0
  4. package/dist-types/commands/AddCacheCommand.d.ts +16 -0
  5. package/dist-types/commands/AddTagsToResourceCommand.d.ts +16 -0
  6. package/dist-types/commands/AddUploadBufferCommand.d.ts +16 -0
  7. package/dist-types/commands/AddWorkingStorageCommand.d.ts +16 -0
  8. package/dist-types/commands/AssignTapePoolCommand.d.ts +16 -0
  9. package/dist-types/commands/AssociateFileSystemCommand.d.ts +16 -0
  10. package/dist-types/commands/AttachVolumeCommand.d.ts +16 -0
  11. package/dist-types/commands/CancelArchivalCommand.d.ts +16 -0
  12. package/dist-types/commands/CancelRetrievalCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateNFSFileShareCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateSMBFileShareCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateSnapshotCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts +16 -0
  19. package/dist-types/commands/CreateTapePoolCommand.d.ts +16 -0
  20. package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts +16 -0
  21. package/dist-types/commands/CreateTapesCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteAutomaticTapeCreationPolicyCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteChapCredentialsCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteFileShareCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteGatewayCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteTapeArchiveCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteTapeCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteTapePoolCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteVolumeCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeAvailabilityMonitorTestCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeBandwidthRateLimitScheduleCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeCacheCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeChapCredentialsCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeFileSystemAssociationsCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeGatewayInformationCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeMaintenanceStartTimeCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeSMBSettingsCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeSnapshotScheduleCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeStorediSCSIVolumesCommand.d.ts +16 -0
  46. package/dist-types/commands/DescribeTapeArchivesCommand.d.ts +16 -0
  47. package/dist-types/commands/DescribeTapeRecoveryPointsCommand.d.ts +16 -0
  48. package/dist-types/commands/DescribeTapesCommand.d.ts +16 -0
  49. package/dist-types/commands/DescribeUploadBufferCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeVTLDevicesCommand.d.ts +16 -0
  51. package/dist-types/commands/DescribeWorkingStorageCommand.d.ts +16 -0
  52. package/dist-types/commands/DetachVolumeCommand.d.ts +16 -0
  53. package/dist-types/commands/DisableGatewayCommand.d.ts +16 -0
  54. package/dist-types/commands/DisassociateFileSystemCommand.d.ts +16 -0
  55. package/dist-types/commands/JoinDomainCommand.d.ts +16 -0
  56. package/dist-types/commands/ListAutomaticTapeCreationPoliciesCommand.d.ts +16 -0
  57. package/dist-types/commands/ListFileSharesCommand.d.ts +16 -0
  58. package/dist-types/commands/ListFileSystemAssociationsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListGatewaysCommand.d.ts +16 -0
  60. package/dist-types/commands/ListLocalDisksCommand.d.ts +16 -0
  61. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  62. package/dist-types/commands/ListTapePoolsCommand.d.ts +16 -0
  63. package/dist-types/commands/ListTapesCommand.d.ts +16 -0
  64. package/dist-types/commands/ListVolumeInitiatorsCommand.d.ts +16 -0
  65. package/dist-types/commands/ListVolumeRecoveryPointsCommand.d.ts +16 -0
  66. package/dist-types/commands/ListVolumesCommand.d.ts +16 -0
  67. package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +16 -0
  68. package/dist-types/commands/RefreshCacheCommand.d.ts +16 -0
  69. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  70. package/dist-types/commands/ResetCacheCommand.d.ts +16 -0
  71. package/dist-types/commands/RetrieveTapeArchiveCommand.d.ts +16 -0
  72. package/dist-types/commands/RetrieveTapeRecoveryPointCommand.d.ts +16 -0
  73. package/dist-types/commands/SetLocalConsolePasswordCommand.d.ts +16 -0
  74. package/dist-types/commands/SetSMBGuestPasswordCommand.d.ts +16 -0
  75. package/dist-types/commands/ShutdownGatewayCommand.d.ts +16 -0
  76. package/dist-types/commands/StartAvailabilityMonitorTestCommand.d.ts +16 -0
  77. package/dist-types/commands/StartGatewayCommand.d.ts +16 -0
  78. package/dist-types/commands/UpdateAutomaticTapeCreationPolicyCommand.d.ts +16 -0
  79. package/dist-types/commands/UpdateBandwidthRateLimitCommand.d.ts +16 -0
  80. package/dist-types/commands/UpdateBandwidthRateLimitScheduleCommand.d.ts +16 -0
  81. package/dist-types/commands/UpdateChapCredentialsCommand.d.ts +16 -0
  82. package/dist-types/commands/UpdateFileSystemAssociationCommand.d.ts +16 -0
  83. package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +16 -0
  84. package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +16 -0
  85. package/dist-types/commands/UpdateMaintenanceStartTimeCommand.d.ts +16 -0
  86. package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +16 -0
  87. package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +16 -0
  88. package/dist-types/commands/UpdateSMBFileShareVisibilityCommand.d.ts +16 -0
  89. package/dist-types/commands/UpdateSMBLocalGroupsCommand.d.ts +16 -0
  90. package/dist-types/commands/UpdateSMBSecurityStrategyCommand.d.ts +16 -0
  91. package/dist-types/commands/UpdateSnapshotScheduleCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateVTLDeviceTypeCommand.d.ts +16 -0
  93. package/dist-types/models/StorageGatewayServiceException.d.ts +2 -0
  94. package/dist-types/models/models_0.d.ts +400 -12
  95. package/dist-types/pagination/DescribeTapeArchivesPaginator.d.ts +3 -0
  96. package/dist-types/pagination/DescribeTapeRecoveryPointsPaginator.d.ts +3 -0
  97. package/dist-types/pagination/DescribeTapesPaginator.d.ts +3 -0
  98. package/dist-types/pagination/DescribeVTLDevicesPaginator.d.ts +3 -0
  99. package/dist-types/pagination/Interfaces.d.ts +3 -0
  100. package/dist-types/pagination/ListFileSharesPaginator.d.ts +3 -0
  101. package/dist-types/pagination/ListFileSystemAssociationsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListGatewaysPaginator.d.ts +3 -0
  103. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  104. package/dist-types/pagination/ListTapePoolsPaginator.d.ts +3 -0
  105. package/dist-types/pagination/ListTapesPaginator.d.ts +3 -0
  106. package/dist-types/pagination/ListVolumesPaginator.d.ts +3 -0
  107. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteGatewayInput, DeleteGatewayOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
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 gateway. To specify which gateway to delete, use the Amazon Resource Name
18
23
  * (ARN) of the gateway in your request. The operation deletes the gateway; however, it does
19
24
  * not delete the gateway virtual machine (VM) from your host computer.</p>
@@ -42,6 +47,8 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param DeleteGatewayCommandInput - {@link DeleteGatewayCommandInput}
51
+ * @returns {@link DeleteGatewayCommandOutput}
45
52
  * @see {@link DeleteGatewayCommandInput} for command's `input` shape.
46
53
  * @see {@link DeleteGatewayCommandOutput} for command's `response` shape.
47
54
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -75,11 +82,20 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
75
82
  export declare class DeleteGatewayCommand extends $Command<DeleteGatewayCommandInput, DeleteGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
76
83
  readonly input: DeleteGatewayCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: DeleteGatewayCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGatewayCommandInput, DeleteGatewayCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSnapshotScheduleInput, DeleteSnapshotScheduleOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSnapshotScheduleCommand}.
8
10
  */
9
11
  export interface DeleteSnapshotScheduleCommandInput extends DeleteSnapshotScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSnapshotScheduleCommand}.
13
17
  */
14
18
  export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a snapshot of a volume.</p>
18
23
  *
19
24
  * <p>You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API
@@ -39,6 +44,8 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param DeleteSnapshotScheduleCommandInput - {@link DeleteSnapshotScheduleCommandInput}
48
+ * @returns {@link DeleteSnapshotScheduleCommandOutput}
42
49
  * @see {@link DeleteSnapshotScheduleCommandInput} for command's `input` shape.
43
50
  * @see {@link DeleteSnapshotScheduleCommandOutput} for command's `response` shape.
44
51
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -72,11 +79,20 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
72
79
  export declare class DeleteSnapshotScheduleCommand extends $Command<DeleteSnapshotScheduleCommandInput, DeleteSnapshotScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
73
80
  readonly input: DeleteSnapshotScheduleCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: DeleteSnapshotScheduleCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSnapshotScheduleCommandInput, DeleteSnapshotScheduleCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteTapeArchiveInput, DeleteTapeArchiveOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTapeArchiveCommand}.
8
10
  */
9
11
  export interface DeleteTapeArchiveCommandInput extends DeleteTapeArchiveInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTapeArchiveCommand}.
13
17
  */
14
18
  export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is
18
23
  * only supported in the tape gateway type.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteTapeArchiveCommandInput - {@link DeleteTapeArchiveCommandInput}
35
+ * @returns {@link DeleteTapeArchiveCommandOutput}
29
36
  * @see {@link DeleteTapeArchiveCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteTapeArchiveCommandOutput} for command's `response` shape.
31
38
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
59
66
  export declare class DeleteTapeArchiveCommand extends $Command<DeleteTapeArchiveCommandInput, DeleteTapeArchiveCommandOutput, StorageGatewayClientResolvedConfig> {
60
67
  readonly input: DeleteTapeArchiveCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DeleteTapeArchiveCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTapeArchiveCommandInput, DeleteTapeArchiveCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteTapeInput, DeleteTapeOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTapeCommand}.
8
10
  */
9
11
  export interface DeleteTapeCommandInput extends DeleteTapeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTapeCommand}.
13
17
  */
14
18
  export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified virtual tape. This operation is only supported in the tape gateway
18
23
  * type.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteTapeCommandInput - {@link DeleteTapeCommandInput}
35
+ * @returns {@link DeleteTapeCommandOutput}
29
36
  * @see {@link DeleteTapeCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteTapeCommandOutput} for command's `response` shape.
31
38
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
60
67
  export declare class DeleteTapeCommand extends $Command<DeleteTapeCommandInput, DeleteTapeCommandOutput, StorageGatewayClientResolvedConfig> {
61
68
  readonly input: DeleteTapeCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteTapeCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTapeCommandInput, DeleteTapeCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteTapePoolInput, DeleteTapePoolOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTapePoolCommand}.
8
10
  */
9
11
  export interface DeleteTapePoolCommandInput extends DeleteTapePoolInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTapePoolCommand}.
13
17
  */
14
18
  export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes
18
23
  * in the pool and if there are no automatic tape creation policies that reference the custom
19
24
  * tape pool.</p>
@@ -27,6 +32,8 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteTapePoolCommandInput - {@link DeleteTapePoolCommandInput}
36
+ * @returns {@link DeleteTapePoolCommandOutput}
30
37
  * @see {@link DeleteTapePoolCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteTapePoolCommandOutput} for command's `response` shape.
32
39
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met
44
51
  export declare class DeleteTapePoolCommand extends $Command<DeleteTapePoolCommandInput, DeleteTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
45
52
  readonly input: DeleteTapePoolCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteTapePoolCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTapePoolCommandInput, DeleteTapePoolCommandOutput>;
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 { DeleteVolumeInput, DeleteVolumeOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteVolumeCommand}.
8
10
  */
9
11
  export interface DeleteVolumeCommandInput extends DeleteVolumeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteVolumeCommand}.
13
17
  */
14
18
  export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified storage volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API.
18
23
  * This operation is only supported in the cached volume and stored volume types. For stored
19
24
  * volume gateways, the local disk that was configured as the storage volume is not deleted.
@@ -37,6 +42,8 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param DeleteVolumeCommandInput - {@link DeleteVolumeCommandInput}
46
+ * @returns {@link DeleteVolumeCommandOutput}
40
47
  * @see {@link DeleteVolumeCommandInput} for command's `input` shape.
41
48
  * @see {@link DeleteVolumeCommandOutput} for command's `response` shape.
42
49
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -70,11 +77,20 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
70
77
  export declare class DeleteVolumeCommand extends $Command<DeleteVolumeCommandInput, DeleteVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
71
78
  readonly input: DeleteVolumeCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: DeleteVolumeCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteVolumeCommandInput, DeleteVolumeCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAvailabilityMonitorTestInput, DescribeAvailabilityMonitorTestOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAvailabilityMonitorTestCommand}.
8
10
  */
9
11
  export interface DescribeAvailabilityMonitorTestCommandInput extends DescribeAvailabilityMonitorTestInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAvailabilityMonitorTestCommand}.
13
17
  */
14
18
  export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAvailabilityMonitorTestOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the most recent high availability monitoring test that was
18
23
  * performed on the host in a cluster. If a test isn't performed, the status and start
19
24
  * time in the response would be null.</p>
@@ -27,6 +32,8 @@ export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAv
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeAvailabilityMonitorTestCommandInput - {@link DescribeAvailabilityMonitorTestCommandInput}
36
+ * @returns {@link DescribeAvailabilityMonitorTestCommandOutput}
30
37
  * @see {@link DescribeAvailabilityMonitorTestCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeAvailabilityMonitorTestCommandOutput} for command's `response` shape.
32
39
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAv
44
51
  export declare class DescribeAvailabilityMonitorTestCommand extends $Command<DescribeAvailabilityMonitorTestCommandInput, DescribeAvailabilityMonitorTestCommandOutput, StorageGatewayClientResolvedConfig> {
45
52
  readonly input: DescribeAvailabilityMonitorTestCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeAvailabilityMonitorTestCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAvailabilityMonitorTestCommandInput, DescribeAvailabilityMonitorTestCommandOutput>;
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 { DescribeBandwidthRateLimitInput, DescribeBandwidthRateLimitOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBandwidthRateLimitCommand}.
8
10
  */
9
11
  export interface DescribeBandwidthRateLimitCommandInput extends DescribeBandwidthRateLimitInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBandwidthRateLimitCommand}.
13
17
  */
14
18
  export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwidthRateLimitOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the bandwidth rate limits of a gateway. By default, these limits are not set,
18
23
  * which means no bandwidth rate limiting is in effect. This operation is supported only for
19
24
  * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits
@@ -33,6 +38,8 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeBandwidthRateLimitCommandInput - {@link DescribeBandwidthRateLimitCommandInput}
42
+ * @returns {@link DescribeBandwidthRateLimitCommandOutput}
36
43
  * @see {@link DescribeBandwidthRateLimitCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeBandwidthRateLimitCommandOutput} for command's `response` shape.
38
45
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -68,11 +75,20 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
68
75
  export declare class DescribeBandwidthRateLimitCommand extends $Command<DescribeBandwidthRateLimitCommandInput, DescribeBandwidthRateLimitCommandOutput, StorageGatewayClientResolvedConfig> {
69
76
  readonly input: DescribeBandwidthRateLimitCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: DescribeBandwidthRateLimitCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBandwidthRateLimitCommandInput, DescribeBandwidthRateLimitCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeBandwidthRateLimitScheduleInput, DescribeBandwidthRateLimitScheduleOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBandwidthRateLimitScheduleCommand}.
8
10
  */
9
11
  export interface DescribeBandwidthRateLimitScheduleCommandInput extends DescribeBandwidthRateLimitScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBandwidthRateLimitScheduleCommand}.
13
17
  */
14
18
  export interface DescribeBandwidthRateLimitScheduleCommandOutput extends DescribeBandwidthRateLimitScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Returns information about the bandwidth rate limit schedule of a gateway. By default,
18
23
  * gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting
19
24
  * is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx
@@ -41,6 +46,8 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput extends Describ
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param DescribeBandwidthRateLimitScheduleCommandInput - {@link DescribeBandwidthRateLimitScheduleCommandInput}
50
+ * @returns {@link DescribeBandwidthRateLimitScheduleCommandOutput}
44
51
  * @see {@link DescribeBandwidthRateLimitScheduleCommandInput} for command's `input` shape.
45
52
  * @see {@link DescribeBandwidthRateLimitScheduleCommandOutput} for command's `response` shape.
46
53
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput extends Describ
58
65
  export declare class DescribeBandwidthRateLimitScheduleCommand extends $Command<DescribeBandwidthRateLimitScheduleCommandInput, DescribeBandwidthRateLimitScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
59
66
  readonly input: DescribeBandwidthRateLimitScheduleCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeBandwidthRateLimitScheduleCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBandwidthRateLimitScheduleCommandInput, DescribeBandwidthRateLimitScheduleCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCacheInput, DescribeCacheOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCacheCommand}.
8
10
  */
9
11
  export interface DescribeCacheCommandInput extends DescribeCacheInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCacheCommand}.
13
17
  */
14
18
  export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the cache of a gateway. This operation is only supported in
18
23
  * the cached volume, tape, and file gateway types.</p>
19
24
  *
@@ -29,6 +34,8 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeCacheCommandInput - {@link DescribeCacheCommandInput}
38
+ * @returns {@link DescribeCacheCommandOutput}
32
39
  * @see {@link DescribeCacheCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeCacheCommandOutput} for command's `response` shape.
34
41
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -71,11 +78,20 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
71
78
  export declare class DescribeCacheCommand extends $Command<DescribeCacheCommandInput, DescribeCacheCommandOutput, StorageGatewayClientResolvedConfig> {
72
79
  readonly input: DescribeCacheCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: DescribeCacheCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCacheCommandInput, DescribeCacheCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCachediSCSIVolumesInput, DescribeCachediSCSIVolumesOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCachediSCSIVolumesCommand}.
8
10
  */
9
11
  export interface DescribeCachediSCSIVolumesCommandInput extends DescribeCachediSCSIVolumesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCachediSCSIVolumesCommand}.
13
17
  */
14
18
  export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachediSCSIVolumesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a description of the gateway volumes specified in the request. This operation is
18
23
  * only supported in the cached volume gateway types.</p>
19
24
  *
@@ -30,6 +35,8 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeCachediSCSIVolumesCommandInput - {@link DescribeCachediSCSIVolumesCommandInput}
39
+ * @returns {@link DescribeCachediSCSIVolumesCommandOutput}
33
40
  * @see {@link DescribeCachediSCSIVolumesCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeCachediSCSIVolumesCommandOutput} for command's `response` shape.
35
42
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -80,11 +87,20 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
80
87
  export declare class DescribeCachediSCSIVolumesCommand extends $Command<DescribeCachediSCSIVolumesCommandInput, DescribeCachediSCSIVolumesCommandOutput, StorageGatewayClientResolvedConfig> {
81
88
  readonly input: DescribeCachediSCSIVolumesCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: DescribeCachediSCSIVolumesCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCachediSCSIVolumesCommandInput, DescribeCachediSCSIVolumesCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeChapCredentialsInput, DescribeChapCredentialsOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChapCredentialsCommand}.
8
10
  */
9
11
  export interface DescribeChapCredentialsCommandInput extends DescribeChapCredentialsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChapCredentialsCommand}.
13
17
  */
14
18
  export interface DescribeChapCredentialsCommandOutput extends DescribeChapCredentialsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials
18
23
  * information for a specified iSCSI target, one for each target-initiator pair. This
19
24
  * operation is supported in the volume and tape gateway types.</p>
@@ -27,6 +32,8 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeChapCredentialsCommandInput - {@link DescribeChapCredentialsCommandInput}
36
+ * @returns {@link DescribeChapCredentialsCommandOutput}
30
37
  * @see {@link DescribeChapCredentialsCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeChapCredentialsCommandOutput} for command's `response` shape.
32
39
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
67
74
  export declare class DescribeChapCredentialsCommand extends $Command<DescribeChapCredentialsCommandInput, DescribeChapCredentialsCommandOutput, StorageGatewayClientResolvedConfig> {
68
75
  readonly input: DescribeChapCredentialsCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DescribeChapCredentialsCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: StorageGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChapCredentialsCommandInput, DescribeChapCredentialsCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }