@aws-sdk/client-fsx 3.288.0 → 3.290.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 (42) hide show
  1. package/dist-types/commands/AssociateFileSystemAliasesCommand.d.ts +10 -0
  2. package/dist-types/commands/CancelDataRepositoryTaskCommand.d.ts +16 -0
  3. package/dist-types/commands/CopyBackupCommand.d.ts +86 -0
  4. package/dist-types/commands/CreateBackupCommand.d.ts +75 -0
  5. package/dist-types/commands/CreateDataRepositoryAssociationCommand.d.ts +22 -0
  6. package/dist-types/commands/CreateDataRepositoryTaskCommand.d.ts +26 -0
  7. package/dist-types/commands/CreateFileCacheCommand.d.ts +25 -0
  8. package/dist-types/commands/CreateFileSystemCommand.d.ts +109 -0
  9. package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +89 -0
  10. package/dist-types/commands/CreateSnapshotCommand.d.ts +14 -0
  11. package/dist-types/commands/CreateStorageVirtualMachineCommand.d.ts +25 -0
  12. package/dist-types/commands/CreateVolumeCommand.d.ts +28 -0
  13. package/dist-types/commands/CreateVolumeFromBackupCommand.d.ts +28 -0
  14. package/dist-types/commands/DeleteBackupCommand.d.ts +43 -0
  15. package/dist-types/commands/DeleteDataRepositoryAssociationCommand.d.ts +19 -0
  16. package/dist-types/commands/DeleteFileCacheCommand.d.ts +19 -0
  17. package/dist-types/commands/DeleteFileSystemCommand.d.ts +36 -0
  18. package/dist-types/commands/DeleteSnapshotCommand.d.ts +10 -0
  19. package/dist-types/commands/DeleteStorageVirtualMachineCommand.d.ts +15 -0
  20. package/dist-types/commands/DeleteVolumeCommand.d.ts +15 -0
  21. package/dist-types/commands/DescribeBackupsCommand.d.ts +55 -0
  22. package/dist-types/commands/DescribeDataRepositoryAssociationsCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeDataRepositoryTasksCommand.d.ts +13 -0
  24. package/dist-types/commands/DescribeFileCachesCommand.d.ts +10 -0
  25. package/dist-types/commands/DescribeFileSystemAliasesCommand.d.ts +10 -0
  26. package/dist-types/commands/DescribeFileSystemsCommand.d.ts +55 -0
  27. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +10 -0
  28. package/dist-types/commands/DescribeStorageVirtualMachinesCommand.d.ts +10 -0
  29. package/dist-types/commands/DescribeVolumesCommand.d.ts +10 -0
  30. package/dist-types/commands/DisassociateFileSystemAliasesCommand.d.ts +10 -0
  31. package/dist-types/commands/ListTagsForResourceCommand.d.ts +38 -0
  32. package/dist-types/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +19 -0
  33. package/dist-types/commands/RestoreVolumeFromSnapshotCommand.d.ts +10 -0
  34. package/dist-types/commands/TagResourceCommand.d.ts +34 -0
  35. package/dist-types/commands/UntagResourceCommand.d.ts +31 -0
  36. package/dist-types/commands/UpdateDataRepositoryAssociationCommand.d.ts +19 -0
  37. package/dist-types/commands/UpdateFileCacheCommand.d.ts +25 -0
  38. package/dist-types/commands/UpdateFileSystemCommand.d.ts +74 -0
  39. package/dist-types/commands/UpdateSnapshotCommand.d.ts +10 -0
  40. package/dist-types/commands/UpdateStorageVirtualMachineCommand.d.ts +18 -0
  41. package/dist-types/commands/UpdateVolumeCommand.d.ts +18 -0
  42. package/package.json +29 -29
@@ -39,6 +39,16 @@ export interface AssociateFileSystemAliasesCommandOutput extends AssociateFileSy
39
39
  * @see {@link AssociateFileSystemAliasesCommandOutput} for command's `response` shape.
40
40
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
41
41
  *
42
+ * @throws {@link BadRequest} (client fault)
43
+ * <p>A generic error indicating a failure with a client request.</p>
44
+ *
45
+ * @throws {@link FileSystemNotFound} (client fault)
46
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
47
+ *
48
+ * @throws {@link InternalServerError} (server fault)
49
+ * <p>A generic error indicating a server-side failure.</p>
50
+ *
51
+ *
42
52
  */
43
53
  export declare class AssociateFileSystemAliasesCommand extends $Command<AssociateFileSystemAliasesCommandInput, AssociateFileSystemAliasesCommandOutput, FSxClientResolvedConfig> {
44
54
  readonly input: AssociateFileSystemAliasesCommandInput;
@@ -41,6 +41,22 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit
41
41
  * @see {@link CancelDataRepositoryTaskCommandOutput} for command's `response` shape.
42
42
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
43
43
  *
44
+ * @throws {@link BadRequest} (client fault)
45
+ * <p>A generic error indicating a failure with a client request.</p>
46
+ *
47
+ * @throws {@link DataRepositoryTaskEnded} (client fault)
48
+ * <p>The data repository task could not be canceled because the task has already ended.</p>
49
+ *
50
+ * @throws {@link DataRepositoryTaskNotFound} (client fault)
51
+ * <p>The data repository task or tasks you specified could not be found.</p>
52
+ *
53
+ * @throws {@link InternalServerError} (server fault)
54
+ * <p>A generic error indicating a server-side failure.</p>
55
+ *
56
+ * @throws {@link UnsupportedOperation} (client fault)
57
+ * <p>The requested operation is not supported for this resource or API.</p>
58
+ *
59
+ *
44
60
  */
45
61
  export declare class CancelDataRepositoryTaskCommand extends $Command<CancelDataRepositoryTaskCommandInput, CancelDataRepositoryTaskCommandOutput, FSxClientResolvedConfig> {
46
62
  readonly input: CancelDataRepositoryTaskCommandInput;
@@ -49,6 +49,92 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
49
49
  * @see {@link CopyBackupCommandOutput} for command's `response` shape.
50
50
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
51
51
  *
52
+ * @throws {@link BackupNotFound} (client fault)
53
+ * <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
54
+ *
55
+ * @throws {@link BadRequest} (client fault)
56
+ * <p>A generic error indicating a failure with a client request.</p>
57
+ *
58
+ * @throws {@link IncompatibleParameterError} (client fault)
59
+ * <p>The error returned when a second request is received with the same client request
60
+ * token but different parameters settings. A client request token should always uniquely
61
+ * identify a single request.</p>
62
+ *
63
+ * @throws {@link IncompatibleRegionForMultiAZ} (client fault)
64
+ * <p>Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the
65
+ * destination Region, so the copied backup can't be restored.</p>
66
+ *
67
+ * @throws {@link InternalServerError} (server fault)
68
+ * <p>A generic error indicating a server-side failure.</p>
69
+ *
70
+ * @throws {@link InvalidDestinationKmsKey} (client fault)
71
+ * <p>The Key Management Service (KMS) key of the destination backup is not
72
+ * valid.</p>
73
+ *
74
+ * @throws {@link InvalidRegion} (client fault)
75
+ * <p>The Region provided for <code>SourceRegion</code> is not valid or is in a different
76
+ * Amazon Web Services partition.</p>
77
+ *
78
+ * @throws {@link InvalidSourceKmsKey} (client fault)
79
+ * <p>The Key Management Service (KMS) key of the source backup is not
80
+ * valid.</p>
81
+ *
82
+ * @throws {@link ServiceLimitExceeded} (client fault)
83
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
84
+ * some service limits by contacting Amazon Web Services Support.</p>
85
+ *
86
+ * @throws {@link SourceBackupUnavailable} (client fault)
87
+ * <p>The request was rejected because the lifecycle status of the source backup isn't
88
+ * <code>AVAILABLE</code>.</p>
89
+ *
90
+ * @throws {@link UnsupportedOperation} (client fault)
91
+ * <p>The requested operation is not supported for this resource or API.</p>
92
+ *
93
+ *
94
+ * @example To copy a backup
95
+ * ```javascript
96
+ * // This operation copies an Amazon FSx backup.
97
+ * const input = {
98
+ * "SourceBackupId": "backup-03e3c82e0183b7b6b",
99
+ * "SourceRegion": "us-east-2"
100
+ * };
101
+ * const command = new CopyBackupCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "Backup": {
106
+ * "BackupId": "backup-0a3364eded1014b28",
107
+ * "CreationTime": 1617954808.068,
108
+ * "FileSystem": {
109
+ * "FileSystemId": "fs-0498eed5fe91001ec",
110
+ * "FileSystemType": "LUSTRE",
111
+ * "LustreConfiguration": {
112
+ * "AutomaticBackupRetentionDays": 0,
113
+ * "DeploymentType": "PERSISTENT_1",
114
+ * "PerUnitStorageThroughput": 50,
115
+ * "WeeklyMaintenanceStartTime": "1:05:00"
116
+ * },
117
+ * "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66",
118
+ * "StorageCapacity": 2400,
119
+ * "StorageType": "SSD"
120
+ * },
121
+ * "KmsKeyId": "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a",
122
+ * "Lifecycle": "COPYING",
123
+ * "OwnerId": "123456789012",
124
+ * "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28",
125
+ * "Tags": [
126
+ * {
127
+ * "Key": "Name",
128
+ * "Value": "MyBackup"
129
+ * }
130
+ * ],
131
+ * "Type": "USER_INITIATED"
132
+ * }
133
+ * }
134
+ * *\/
135
+ * // example id: to-copy-a-backup-1481847318640
136
+ * ```
137
+ *
52
138
  */
53
139
  export declare class CopyBackupCommand extends $Command<CopyBackupCommandInput, CopyBackupCommandOutput, FSxClientResolvedConfig> {
54
140
  readonly input: CopyBackupCommandInput;
@@ -84,6 +84,81 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
84
84
  * @see {@link CreateBackupCommandOutput} for command's `response` shape.
85
85
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
86
86
  *
87
+ * @throws {@link BackupInProgress} (client fault)
88
+ * <p>Another backup is already under way. Wait for completion before initiating
89
+ * additional backups of this file system.</p>
90
+ *
91
+ * @throws {@link BadRequest} (client fault)
92
+ * <p>A generic error indicating a failure with a client request.</p>
93
+ *
94
+ * @throws {@link FileSystemNotFound} (client fault)
95
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
96
+ *
97
+ * @throws {@link IncompatibleParameterError} (client fault)
98
+ * <p>The error returned when a second request is received with the same client request
99
+ * token but different parameters settings. A client request token should always uniquely
100
+ * identify a single request.</p>
101
+ *
102
+ * @throws {@link InternalServerError} (server fault)
103
+ * <p>A generic error indicating a server-side failure.</p>
104
+ *
105
+ * @throws {@link ServiceLimitExceeded} (client fault)
106
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
107
+ * some service limits by contacting Amazon Web Services Support.</p>
108
+ *
109
+ * @throws {@link UnsupportedOperation} (client fault)
110
+ * <p>The requested operation is not supported for this resource or API.</p>
111
+ *
112
+ * @throws {@link VolumeNotFound} (client fault)
113
+ * <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
114
+ *
115
+ *
116
+ * @example To create a new backup
117
+ * ```javascript
118
+ * // This operation creates a new backup.
119
+ * const input = {
120
+ * "FileSystemId": "fs-0498eed5fe91001ec",
121
+ * "Tags": [
122
+ * {
123
+ * "Key": "Name",
124
+ * "Value": "MyBackup"
125
+ * }
126
+ * ]
127
+ * };
128
+ * const command = new CreateBackupCommand(input);
129
+ * const response = await client.send(command);
130
+ * /* response ==
131
+ * {
132
+ * "Backup": {
133
+ * "BackupId": "backup-03e3c82e0183b7b6b",
134
+ * "CreationTime": "1481841524.0",
135
+ * "FileSystem": {
136
+ * "FileSystemId": "fs-0498eed5fe91001ec",
137
+ * "OwnerId": "012345678912",
138
+ * "StorageCapacity": 300,
139
+ * "WindowsConfiguration": {
140
+ * "ActiveDirectoryId": "d-1234abcd12",
141
+ * "AutomaticBackupRetentionDays": 30,
142
+ * "DailyAutomaticBackupStartTime": "05:00",
143
+ * "WeeklyMaintenanceStartTime": "1:05:00"
144
+ * }
145
+ * },
146
+ * "Lifecycle": "CREATING",
147
+ * "ProgressPercent": 0,
148
+ * "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
149
+ * "Tags": [
150
+ * {
151
+ * "Key": "Name",
152
+ * "Value": "MyBackup"
153
+ * }
154
+ * ],
155
+ * "Type": "USER_INITIATED"
156
+ * }
157
+ * }
158
+ * *\/
159
+ * // example id: to-create-a-new-backup-1481840798597
160
+ * ```
161
+ *
87
162
  */
88
163
  export declare class CreateBackupCommand extends $Command<CreateBackupCommandInput, CreateBackupCommandOutput, FSxClientResolvedConfig> {
89
164
  readonly input: CreateBackupCommandInput;
@@ -45,6 +45,28 @@ export interface CreateDataRepositoryAssociationCommandOutput extends CreateData
45
45
  * @see {@link CreateDataRepositoryAssociationCommandOutput} for command's `response` shape.
46
46
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
47
47
  *
48
+ * @throws {@link BadRequest} (client fault)
49
+ * <p>A generic error indicating a failure with a client request.</p>
50
+ *
51
+ * @throws {@link FileSystemNotFound} (client fault)
52
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
53
+ *
54
+ * @throws {@link IncompatibleParameterError} (client fault)
55
+ * <p>The error returned when a second request is received with the same client request
56
+ * token but different parameters settings. A client request token should always uniquely
57
+ * identify a single request.</p>
58
+ *
59
+ * @throws {@link InternalServerError} (server fault)
60
+ * <p>A generic error indicating a server-side failure.</p>
61
+ *
62
+ * @throws {@link ServiceLimitExceeded} (client fault)
63
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
64
+ * some service limits by contacting Amazon Web Services Support.</p>
65
+ *
66
+ * @throws {@link UnsupportedOperation} (client fault)
67
+ * <p>The requested operation is not supported for this resource or API.</p>
68
+ *
69
+ *
48
70
  */
49
71
  export declare class CreateDataRepositoryAssociationCommand extends $Command<CreateDataRepositoryAssociationCommandInput, CreateDataRepositoryAssociationCommandOutput, FSxClientResolvedConfig> {
50
72
  readonly input: CreateDataRepositoryAssociationCommandInput;
@@ -38,6 +38,32 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit
38
38
  * @see {@link CreateDataRepositoryTaskCommandOutput} for command's `response` shape.
39
39
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
40
40
  *
41
+ * @throws {@link BadRequest} (client fault)
42
+ * <p>A generic error indicating a failure with a client request.</p>
43
+ *
44
+ * @throws {@link DataRepositoryTaskExecuting} (client fault)
45
+ * <p>An existing data repository task is currently executing on the file system.
46
+ * Wait until the existing task has completed, then create the new task.</p>
47
+ *
48
+ * @throws {@link FileSystemNotFound} (client fault)
49
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
50
+ *
51
+ * @throws {@link IncompatibleParameterError} (client fault)
52
+ * <p>The error returned when a second request is received with the same client request
53
+ * token but different parameters settings. A client request token should always uniquely
54
+ * identify a single request.</p>
55
+ *
56
+ * @throws {@link InternalServerError} (server fault)
57
+ * <p>A generic error indicating a server-side failure.</p>
58
+ *
59
+ * @throws {@link ServiceLimitExceeded} (client fault)
60
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
61
+ * some service limits by contacting Amazon Web Services Support.</p>
62
+ *
63
+ * @throws {@link UnsupportedOperation} (client fault)
64
+ * <p>The requested operation is not supported for this resource or API.</p>
65
+ *
66
+ *
41
67
  */
42
68
  export declare class CreateDataRepositoryTaskCommand extends $Command<CreateDataRepositoryTaskCommandInput, CreateDataRepositoryTaskCommandOutput, FSxClientResolvedConfig> {
43
69
  readonly input: CreateDataRepositoryTaskCommandInput;
@@ -52,6 +52,31 @@ export interface CreateFileCacheCommandOutput extends CreateFileCacheResponse, _
52
52
  * @see {@link CreateFileCacheCommandOutput} for command's `response` shape.
53
53
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
54
54
  *
55
+ * @throws {@link BadRequest} (client fault)
56
+ * <p>A generic error indicating a failure with a client request.</p>
57
+ *
58
+ * @throws {@link IncompatibleParameterError} (client fault)
59
+ * <p>The error returned when a second request is received with the same client request
60
+ * token but different parameters settings. A client request token should always uniquely
61
+ * identify a single request.</p>
62
+ *
63
+ * @throws {@link InternalServerError} (server fault)
64
+ * <p>A generic error indicating a server-side failure.</p>
65
+ *
66
+ * @throws {@link InvalidNetworkSettings} (client fault)
67
+ * <p>One or more network settings specified in the request are invalid.</p>
68
+ *
69
+ * @throws {@link InvalidPerUnitStorageThroughput} (client fault)
70
+ * <p>An invalid value for <code>PerUnitStorageThroughput</code> was provided. Please create your file system again, using a valid value.</p>
71
+ *
72
+ * @throws {@link MissingFileCacheConfiguration} (client fault)
73
+ * <p>A cache configuration is required for this operation.</p>
74
+ *
75
+ * @throws {@link ServiceLimitExceeded} (client fault)
76
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
77
+ * some service limits by contacting Amazon Web Services Support.</p>
78
+ *
79
+ *
55
80
  */
56
81
  export declare class CreateFileCacheCommand extends $Command<CreateFileCacheCommandInput, CreateFileCacheCommandOutput, FSxClientResolvedConfig> {
57
82
  readonly input: CreateFileCacheCommandInput;
@@ -74,6 +74,115 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
74
74
  * @see {@link CreateFileSystemCommandOutput} for command's `response` shape.
75
75
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
76
76
  *
77
+ * @throws {@link ActiveDirectoryError} (client fault)
78
+ * <p>An Active Directory error.</p>
79
+ *
80
+ * @throws {@link BadRequest} (client fault)
81
+ * <p>A generic error indicating a failure with a client request.</p>
82
+ *
83
+ * @throws {@link IncompatibleParameterError} (client fault)
84
+ * <p>The error returned when a second request is received with the same client request
85
+ * token but different parameters settings. A client request token should always uniquely
86
+ * identify a single request.</p>
87
+ *
88
+ * @throws {@link InternalServerError} (server fault)
89
+ * <p>A generic error indicating a server-side failure.</p>
90
+ *
91
+ * @throws {@link InvalidExportPath} (client fault)
92
+ * <p>The path provided for data repository export isn't valid.</p>
93
+ *
94
+ * @throws {@link InvalidImportPath} (client fault)
95
+ * <p>The path provided for data repository import isn't valid.</p>
96
+ *
97
+ * @throws {@link InvalidNetworkSettings} (client fault)
98
+ * <p>One or more network settings specified in the request are invalid.</p>
99
+ *
100
+ * @throws {@link InvalidPerUnitStorageThroughput} (client fault)
101
+ * <p>An invalid value for <code>PerUnitStorageThroughput</code> was provided. Please create your file system again, using a valid value.</p>
102
+ *
103
+ * @throws {@link MissingFileSystemConfiguration} (client fault)
104
+ * <p>A file system configuration is required for this operation.</p>
105
+ *
106
+ * @throws {@link ServiceLimitExceeded} (client fault)
107
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
108
+ * some service limits by contacting Amazon Web Services Support.</p>
109
+ *
110
+ *
111
+ * @example To create a new file system
112
+ * ```javascript
113
+ * // This operation creates a new Amazon FSx for Windows File Server file system.
114
+ * const input = {
115
+ * "ClientRequestToken": "a8ca07e4-61ec-4399-99f4-19853801bcd5",
116
+ * "FileSystemType": "WINDOWS",
117
+ * "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff",
118
+ * "SecurityGroupIds": [
119
+ * "sg-edcd9784"
120
+ * ],
121
+ * "StorageCapacity": 3200,
122
+ * "StorageType": "HDD",
123
+ * "SubnetIds": [
124
+ * "subnet-1234abcd"
125
+ * ],
126
+ * "Tags": [
127
+ * {
128
+ * "Key": "Name",
129
+ * "Value": "MyFileSystem"
130
+ * }
131
+ * ],
132
+ * "WindowsConfiguration": {
133
+ * "ActiveDirectoryId": "d-1234abcd12",
134
+ * "Aliases": [
135
+ * "accounting.corp.example.com"
136
+ * ],
137
+ * "AutomaticBackupRetentionDays": 30,
138
+ * "DailyAutomaticBackupStartTime": "05:00",
139
+ * "ThroughputCapacity": 32,
140
+ * "WeeklyMaintenanceStartTime": "1:05:00"
141
+ * }
142
+ * };
143
+ * const command = new CreateFileSystemCommand(input);
144
+ * const response = await client.send(command);
145
+ * /* response ==
146
+ * {
147
+ * "FileSystem": {
148
+ * "CreationTime": "1481841524.0",
149
+ * "DNSName": "fs-0123456789abcdef0.fsx.com",
150
+ * "FileSystemId": "fs-0123456789abcdef0",
151
+ * "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff",
152
+ * "Lifecycle": "CREATING",
153
+ * "OwnerId": "012345678912",
154
+ * "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0",
155
+ * "StorageCapacity": 3200,
156
+ * "StorageType": "HDD",
157
+ * "SubnetIds": [
158
+ * "subnet-1234abcd"
159
+ * ],
160
+ * "Tags": [
161
+ * {
162
+ * "Key": "Name",
163
+ * "Value": "MyFileSystem"
164
+ * }
165
+ * ],
166
+ * "VpcId": "vpc-ab1234cd",
167
+ * "WindowsConfiguration": {
168
+ * "ActiveDirectoryId": "d-1234abcd12",
169
+ * "Aliases": [
170
+ * {
171
+ * "Lifecycle": "CREATING",
172
+ * "Name": "accounting.corp.example.com"
173
+ * }
174
+ * ],
175
+ * "AutomaticBackupRetentionDays": 30,
176
+ * "DailyAutomaticBackupStartTime": "05:00",
177
+ * "ThroughputCapacity": 32,
178
+ * "WeeklyMaintenanceStartTime": "1:05:00"
179
+ * }
180
+ * }
181
+ * }
182
+ * *\/
183
+ * // example id: to-create-a-new-file-system-1481840798547
184
+ * ```
185
+ *
77
186
  */
78
187
  export declare class CreateFileSystemCommand extends $Command<CreateFileSystemCommandInput, CreateFileSystemCommandOutput, FSxClientResolvedConfig> {
79
188
  readonly input: CreateFileSystemCommandInput;
@@ -61,6 +61,95 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
61
61
  * @see {@link CreateFileSystemFromBackupCommandOutput} for command's `response` shape.
62
62
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
63
63
  *
64
+ * @throws {@link ActiveDirectoryError} (client fault)
65
+ * <p>An Active Directory error.</p>
66
+ *
67
+ * @throws {@link BackupNotFound} (client fault)
68
+ * <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
69
+ *
70
+ * @throws {@link BadRequest} (client fault)
71
+ * <p>A generic error indicating a failure with a client request.</p>
72
+ *
73
+ * @throws {@link IncompatibleParameterError} (client fault)
74
+ * <p>The error returned when a second request is received with the same client request
75
+ * token but different parameters settings. A client request token should always uniquely
76
+ * identify a single request.</p>
77
+ *
78
+ * @throws {@link InternalServerError} (server fault)
79
+ * <p>A generic error indicating a server-side failure.</p>
80
+ *
81
+ * @throws {@link InvalidNetworkSettings} (client fault)
82
+ * <p>One or more network settings specified in the request are invalid.</p>
83
+ *
84
+ * @throws {@link InvalidPerUnitStorageThroughput} (client fault)
85
+ * <p>An invalid value for <code>PerUnitStorageThroughput</code> was provided. Please create your file system again, using a valid value.</p>
86
+ *
87
+ * @throws {@link MissingFileSystemConfiguration} (client fault)
88
+ * <p>A file system configuration is required for this operation.</p>
89
+ *
90
+ * @throws {@link ServiceLimitExceeded} (client fault)
91
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
92
+ * some service limits by contacting Amazon Web Services Support.</p>
93
+ *
94
+ *
95
+ * @example To create a new file system from backup
96
+ * ```javascript
97
+ * // This operation creates a new file system from backup.
98
+ * const input = {
99
+ * "BackupId": "backup-03e3c82e0183b7b6b",
100
+ * "ClientRequestToken": "f4c94ed7-238d-4c46-93db-48cd62ec33b7",
101
+ * "SecurityGroupIds": [
102
+ * "sg-edcd9784"
103
+ * ],
104
+ * "SubnetIds": [
105
+ * "subnet-1234abcd"
106
+ * ],
107
+ * "Tags": [
108
+ * {
109
+ * "Key": "Name",
110
+ * "Value": "MyFileSystem"
111
+ * }
112
+ * ],
113
+ * "WindowsConfiguration": {
114
+ * "ThroughputCapacity": 8
115
+ * }
116
+ * };
117
+ * const command = new CreateFileSystemFromBackupCommand(input);
118
+ * const response = await client.send(command);
119
+ * /* response ==
120
+ * {
121
+ * "FileSystem": {
122
+ * "CreationTime": "1481841524.0",
123
+ * "DNSName": "fs-0498eed5fe91001ec.fsx.com",
124
+ * "FileSystemId": "fs-0498eed5fe91001ec",
125
+ * "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
126
+ * "Lifecycle": "CREATING",
127
+ * "OwnerId": "012345678912",
128
+ * "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
129
+ * "StorageCapacity": 300,
130
+ * "SubnetIds": [
131
+ * "subnet-1234abcd"
132
+ * ],
133
+ * "Tags": [
134
+ * {
135
+ * "Key": "Name",
136
+ * "Value": "MyFileSystem"
137
+ * }
138
+ * ],
139
+ * "VpcId": "vpc-ab1234cd",
140
+ * "WindowsConfiguration": {
141
+ * "ActiveDirectoryId": "d-1234abcd12",
142
+ * "AutomaticBackupRetentionDays": 30,
143
+ * "DailyAutomaticBackupStartTime": "05:00",
144
+ * "ThroughputCapacity": 8,
145
+ * "WeeklyMaintenanceStartTime": "1:05:00"
146
+ * }
147
+ * }
148
+ * }
149
+ * *\/
150
+ * // example id: to-create-a-new-file-system-from-backup-1481840798598
151
+ * ```
152
+ *
64
153
  */
65
154
  export declare class CreateFileSystemFromBackupCommand extends $Command<CreateFileSystemFromBackupCommandInput, CreateFileSystemFromBackupCommandOutput, FSxClientResolvedConfig> {
66
155
  readonly input: CreateFileSystemFromBackupCommandInput;
@@ -56,6 +56,20 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
56
56
  * @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
57
57
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
58
58
  *
59
+ * @throws {@link BadRequest} (client fault)
60
+ * <p>A generic error indicating a failure with a client request.</p>
61
+ *
62
+ * @throws {@link InternalServerError} (server fault)
63
+ * <p>A generic error indicating a server-side failure.</p>
64
+ *
65
+ * @throws {@link ServiceLimitExceeded} (client fault)
66
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
67
+ * some service limits by contacting Amazon Web Services Support.</p>
68
+ *
69
+ * @throws {@link VolumeNotFound} (client fault)
70
+ * <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
71
+ *
72
+ *
59
73
  */
60
74
  export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, FSxClientResolvedConfig> {
61
75
  readonly input: CreateSnapshotCommandInput;
@@ -29,6 +29,31 @@ export interface CreateStorageVirtualMachineCommandOutput extends CreateStorageV
29
29
  * @see {@link CreateStorageVirtualMachineCommandOutput} for command's `response` shape.
30
30
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
31
31
  *
32
+ * @throws {@link ActiveDirectoryError} (client fault)
33
+ * <p>An Active Directory error.</p>
34
+ *
35
+ * @throws {@link BadRequest} (client fault)
36
+ * <p>A generic error indicating a failure with a client request.</p>
37
+ *
38
+ * @throws {@link FileSystemNotFound} (client fault)
39
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
40
+ *
41
+ * @throws {@link IncompatibleParameterError} (client fault)
42
+ * <p>The error returned when a second request is received with the same client request
43
+ * token but different parameters settings. A client request token should always uniquely
44
+ * identify a single request.</p>
45
+ *
46
+ * @throws {@link InternalServerError} (server fault)
47
+ * <p>A generic error indicating a server-side failure.</p>
48
+ *
49
+ * @throws {@link ServiceLimitExceeded} (client fault)
50
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
51
+ * some service limits by contacting Amazon Web Services Support.</p>
52
+ *
53
+ * @throws {@link UnsupportedOperation} (client fault)
54
+ * <p>The requested operation is not supported for this resource or API.</p>
55
+ *
56
+ *
32
57
  */
33
58
  export declare class CreateStorageVirtualMachineCommand extends $Command<CreateStorageVirtualMachineCommandInput, CreateStorageVirtualMachineCommandOutput, FSxClientResolvedConfig> {
34
59
  readonly input: CreateStorageVirtualMachineCommandInput;
@@ -29,6 +29,34 @@ export interface CreateVolumeCommandOutput extends CreateVolumeResponse, __Metad
29
29
  * @see {@link CreateVolumeCommandOutput} for command's `response` shape.
30
30
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
31
31
  *
32
+ * @throws {@link BadRequest} (client fault)
33
+ * <p>A generic error indicating a failure with a client request.</p>
34
+ *
35
+ * @throws {@link FileSystemNotFound} (client fault)
36
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
37
+ *
38
+ * @throws {@link IncompatibleParameterError} (client fault)
39
+ * <p>The error returned when a second request is received with the same client request
40
+ * token but different parameters settings. A client request token should always uniquely
41
+ * identify a single request.</p>
42
+ *
43
+ * @throws {@link InternalServerError} (server fault)
44
+ * <p>A generic error indicating a server-side failure.</p>
45
+ *
46
+ * @throws {@link MissingVolumeConfiguration} (client fault)
47
+ * <p>A volume configuration is required for this operation.</p>
48
+ *
49
+ * @throws {@link ServiceLimitExceeded} (client fault)
50
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
51
+ * some service limits by contacting Amazon Web Services Support.</p>
52
+ *
53
+ * @throws {@link StorageVirtualMachineNotFound} (client fault)
54
+ * <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
55
+ *
56
+ * @throws {@link UnsupportedOperation} (client fault)
57
+ * <p>The requested operation is not supported for this resource or API.</p>
58
+ *
59
+ *
32
60
  */
33
61
  export declare class CreateVolumeCommand extends $Command<CreateVolumeCommandInput, CreateVolumeCommandOutput, FSxClientResolvedConfig> {
34
62
  readonly input: CreateVolumeCommandInput;
@@ -30,6 +30,34 @@ export interface CreateVolumeFromBackupCommandOutput extends CreateVolumeFromBac
30
30
  * @see {@link CreateVolumeFromBackupCommandOutput} for command's `response` shape.
31
31
  * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
32
32
  *
33
+ * @throws {@link BackupNotFound} (client fault)
34
+ * <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
35
+ *
36
+ * @throws {@link BadRequest} (client fault)
37
+ * <p>A generic error indicating a failure with a client request.</p>
38
+ *
39
+ * @throws {@link FileSystemNotFound} (client fault)
40
+ * <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
41
+ *
42
+ * @throws {@link IncompatibleParameterError} (client fault)
43
+ * <p>The error returned when a second request is received with the same client request
44
+ * token but different parameters settings. A client request token should always uniquely
45
+ * identify a single request.</p>
46
+ *
47
+ * @throws {@link InternalServerError} (server fault)
48
+ * <p>A generic error indicating a server-side failure.</p>
49
+ *
50
+ * @throws {@link MissingVolumeConfiguration} (client fault)
51
+ * <p>A volume configuration is required for this operation.</p>
52
+ *
53
+ * @throws {@link ServiceLimitExceeded} (client fault)
54
+ * <p>An error indicating that a particular service limit was exceeded. You can increase
55
+ * some service limits by contacting Amazon Web Services Support.</p>
56
+ *
57
+ * @throws {@link StorageVirtualMachineNotFound} (client fault)
58
+ * <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
59
+ *
60
+ *
33
61
  */
34
62
  export declare class CreateVolumeFromBackupCommand extends $Command<CreateVolumeFromBackupCommandInput, CreateVolumeFromBackupCommandOutput, FSxClientResolvedConfig> {
35
63
  readonly input: CreateVolumeFromBackupCommandInput;