@aws-sdk/client-fsx 3.43.0 → 3.44.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.
- package/CHANGELOG.md +11 -0
- package/dist-cjs/FSx.js +150 -0
- package/dist-cjs/commands/CreateDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/CreateSnapshotCommand.js +36 -0
- package/dist-cjs/commands/DeleteDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/DeleteSnapshotCommand.js +36 -0
- package/dist-cjs/commands/DescribeDataRepositoryAssociationsCommand.js +36 -0
- package/dist-cjs/commands/DescribeSnapshotsCommand.js +36 -0
- package/dist-cjs/commands/ReleaseFileSystemNfsV3LocksCommand.js +36 -0
- package/dist-cjs/commands/RestoreVolumeFromSnapshotCommand.js +36 -0
- package/dist-cjs/commands/UpdateDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/UpdateSnapshotCommand.js +36 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/models/models_0.js +386 -44
- package/dist-cjs/pagination/DescribeDataRepositoryAssociationsPaginator.js +35 -0
- package/dist-cjs/pagination/DescribeSnapshotsPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1745 -131
- package/dist-es/FSx.js +150 -0
- package/dist-es/commands/CreateDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/CreateSnapshotCommand.js +39 -0
- package/dist-es/commands/DeleteDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/DeleteSnapshotCommand.js +39 -0
- package/dist-es/commands/DescribeDataRepositoryAssociationsCommand.js +39 -0
- package/dist-es/commands/DescribeSnapshotsCommand.js +39 -0
- package/dist-es/commands/ReleaseFileSystemNfsV3LocksCommand.js +39 -0
- package/dist-es/commands/RestoreVolumeFromSnapshotCommand.js +39 -0
- package/dist-es/commands/UpdateDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/UpdateSnapshotCommand.js +39 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +277 -28
- package/dist-es/pagination/DescribeDataRepositoryAssociationsPaginator.js +74 -0
- package/dist-es/pagination/DescribeSnapshotsPaginator.js +74 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +1653 -74
- package/dist-types/FSx.d.ts +406 -146
- package/dist-types/FSxClient.d.ts +12 -2
- package/dist-types/commands/CopyBackupCommand.d.ts +12 -12
- package/dist-types/commands/CreateBackupCommand.d.ts +27 -25
- package/dist-types/commands/CreateDataRepositoryAssociationCommand.d.ts +45 -0
- package/dist-types/commands/CreateDataRepositoryTaskCommand.d.ts +6 -5
- package/dist-types/commands/CreateFileSystemCommand.d.ts +36 -16
- package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +14 -14
- package/dist-types/commands/CreateSnapshotCommand.d.ts +62 -0
- package/dist-types/commands/CreateVolumeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBackupCommand.d.ts +4 -3
- package/dist-types/commands/DeleteDataRepositoryAssociationCommand.d.ts +41 -0
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +14 -15
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +39 -0
- package/dist-types/commands/DeleteVolumeCommand.d.ts +2 -4
- package/dist-types/commands/DescribeBackupsCommand.d.ts +17 -18
- package/dist-types/commands/DescribeDataRepositoryAssociationsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeFileSystemsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +61 -0
- package/dist-types/commands/DescribeVolumesCommand.d.ts +2 -1
- package/dist-types/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +36 -0
- package/dist-types/commands/RestoreVolumeFromSnapshotCommand.d.ts +36 -0
- package/dist-types/commands/UpdateDataRepositoryAssociationCommand.d.ts +37 -0
- package/dist-types/commands/UpdateFileSystemCommand.d.ts +95 -22
- package/dist-types/commands/UpdateSnapshotCommand.d.ts +35 -0
- package/dist-types/commands/UpdateVolumeCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +2705 -649
- package/dist-types/pagination/DescribeDataRepositoryAssociationsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeSnapshotsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/FSx.d.ts +50 -0
- package/dist-types/ts3.4/FSxClient.d.ts +12 -2
- package/dist-types/ts3.4/commands/CreateDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeDataRepositoryAssociationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeSnapshotsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RestoreVolumeFromSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +790 -81
- package/dist-types/ts3.4/pagination/DescribeDataRepositoryAssociationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/DescribeSnapshotsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +1 -1
|
@@ -10,31 +10,41 @@ import { AssociateFileSystemAliasesCommandInput, AssociateFileSystemAliasesComma
|
|
|
10
10
|
import { CancelDataRepositoryTaskCommandInput, CancelDataRepositoryTaskCommandOutput } from "./commands/CancelDataRepositoryTaskCommand";
|
|
11
11
|
import { CopyBackupCommandInput, CopyBackupCommandOutput } from "./commands/CopyBackupCommand";
|
|
12
12
|
import { CreateBackupCommandInput, CreateBackupCommandOutput } from "./commands/CreateBackupCommand";
|
|
13
|
+
import { CreateDataRepositoryAssociationCommandInput, CreateDataRepositoryAssociationCommandOutput } from "./commands/CreateDataRepositoryAssociationCommand";
|
|
13
14
|
import { CreateDataRepositoryTaskCommandInput, CreateDataRepositoryTaskCommandOutput } from "./commands/CreateDataRepositoryTaskCommand";
|
|
14
15
|
import { CreateFileSystemCommandInput, CreateFileSystemCommandOutput } from "./commands/CreateFileSystemCommand";
|
|
15
16
|
import { CreateFileSystemFromBackupCommandInput, CreateFileSystemFromBackupCommandOutput } from "./commands/CreateFileSystemFromBackupCommand";
|
|
17
|
+
import { CreateSnapshotCommandInput, CreateSnapshotCommandOutput } from "./commands/CreateSnapshotCommand";
|
|
16
18
|
import { CreateStorageVirtualMachineCommandInput, CreateStorageVirtualMachineCommandOutput } from "./commands/CreateStorageVirtualMachineCommand";
|
|
17
19
|
import { CreateVolumeCommandInput, CreateVolumeCommandOutput } from "./commands/CreateVolumeCommand";
|
|
18
20
|
import { CreateVolumeFromBackupCommandInput, CreateVolumeFromBackupCommandOutput } from "./commands/CreateVolumeFromBackupCommand";
|
|
19
21
|
import { DeleteBackupCommandInput, DeleteBackupCommandOutput } from "./commands/DeleteBackupCommand";
|
|
22
|
+
import { DeleteDataRepositoryAssociationCommandInput, DeleteDataRepositoryAssociationCommandOutput } from "./commands/DeleteDataRepositoryAssociationCommand";
|
|
20
23
|
import { DeleteFileSystemCommandInput, DeleteFileSystemCommandOutput } from "./commands/DeleteFileSystemCommand";
|
|
24
|
+
import { DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput } from "./commands/DeleteSnapshotCommand";
|
|
21
25
|
import { DeleteStorageVirtualMachineCommandInput, DeleteStorageVirtualMachineCommandOutput } from "./commands/DeleteStorageVirtualMachineCommand";
|
|
22
26
|
import { DeleteVolumeCommandInput, DeleteVolumeCommandOutput } from "./commands/DeleteVolumeCommand";
|
|
23
27
|
import { DescribeBackupsCommandInput, DescribeBackupsCommandOutput } from "./commands/DescribeBackupsCommand";
|
|
28
|
+
import { DescribeDataRepositoryAssociationsCommandInput, DescribeDataRepositoryAssociationsCommandOutput } from "./commands/DescribeDataRepositoryAssociationsCommand";
|
|
24
29
|
import { DescribeDataRepositoryTasksCommandInput, DescribeDataRepositoryTasksCommandOutput } from "./commands/DescribeDataRepositoryTasksCommand";
|
|
25
30
|
import { DescribeFileSystemAliasesCommandInput, DescribeFileSystemAliasesCommandOutput } from "./commands/DescribeFileSystemAliasesCommand";
|
|
26
31
|
import { DescribeFileSystemsCommandInput, DescribeFileSystemsCommandOutput } from "./commands/DescribeFileSystemsCommand";
|
|
32
|
+
import { DescribeSnapshotsCommandInput, DescribeSnapshotsCommandOutput } from "./commands/DescribeSnapshotsCommand";
|
|
27
33
|
import { DescribeStorageVirtualMachinesCommandInput, DescribeStorageVirtualMachinesCommandOutput } from "./commands/DescribeStorageVirtualMachinesCommand";
|
|
28
34
|
import { DescribeVolumesCommandInput, DescribeVolumesCommandOutput } from "./commands/DescribeVolumesCommand";
|
|
29
35
|
import { DisassociateFileSystemAliasesCommandInput, DisassociateFileSystemAliasesCommandOutput } from "./commands/DisassociateFileSystemAliasesCommand";
|
|
30
36
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
37
|
+
import { ReleaseFileSystemNfsV3LocksCommandInput, ReleaseFileSystemNfsV3LocksCommandOutput } from "./commands/ReleaseFileSystemNfsV3LocksCommand";
|
|
38
|
+
import { RestoreVolumeFromSnapshotCommandInput, RestoreVolumeFromSnapshotCommandOutput } from "./commands/RestoreVolumeFromSnapshotCommand";
|
|
31
39
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
32
40
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
41
|
+
import { UpdateDataRepositoryAssociationCommandInput, UpdateDataRepositoryAssociationCommandOutput } from "./commands/UpdateDataRepositoryAssociationCommand";
|
|
33
42
|
import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput } from "./commands/UpdateFileSystemCommand";
|
|
43
|
+
import { UpdateSnapshotCommandInput, UpdateSnapshotCommandOutput } from "./commands/UpdateSnapshotCommand";
|
|
34
44
|
import { UpdateStorageVirtualMachineCommandInput, UpdateStorageVirtualMachineCommandOutput } from "./commands/UpdateStorageVirtualMachineCommand";
|
|
35
45
|
import { UpdateVolumeCommandInput, UpdateVolumeCommandOutput } from "./commands/UpdateVolumeCommand";
|
|
36
|
-
export declare type ServiceInputTypes = AssociateFileSystemAliasesCommandInput | CancelDataRepositoryTaskCommandInput | CopyBackupCommandInput | CreateBackupCommandInput | CreateDataRepositoryTaskCommandInput | CreateFileSystemCommandInput | CreateFileSystemFromBackupCommandInput | CreateStorageVirtualMachineCommandInput | CreateVolumeCommandInput | CreateVolumeFromBackupCommandInput | DeleteBackupCommandInput | DeleteFileSystemCommandInput | DeleteStorageVirtualMachineCommandInput | DeleteVolumeCommandInput | DescribeBackupsCommandInput | DescribeDataRepositoryTasksCommandInput | DescribeFileSystemAliasesCommandInput | DescribeFileSystemsCommandInput | DescribeStorageVirtualMachinesCommandInput | DescribeVolumesCommandInput | DisassociateFileSystemAliasesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateFileSystemCommandInput | UpdateStorageVirtualMachineCommandInput | UpdateVolumeCommandInput;
|
|
37
|
-
export declare type ServiceOutputTypes = AssociateFileSystemAliasesCommandOutput | CancelDataRepositoryTaskCommandOutput | CopyBackupCommandOutput | CreateBackupCommandOutput | CreateDataRepositoryTaskCommandOutput | CreateFileSystemCommandOutput | CreateFileSystemFromBackupCommandOutput | CreateStorageVirtualMachineCommandOutput | CreateVolumeCommandOutput | CreateVolumeFromBackupCommandOutput | DeleteBackupCommandOutput | DeleteFileSystemCommandOutput | DeleteStorageVirtualMachineCommandOutput | DeleteVolumeCommandOutput | DescribeBackupsCommandOutput | DescribeDataRepositoryTasksCommandOutput | DescribeFileSystemAliasesCommandOutput | DescribeFileSystemsCommandOutput | DescribeStorageVirtualMachinesCommandOutput | DescribeVolumesCommandOutput | DisassociateFileSystemAliasesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateFileSystemCommandOutput | UpdateStorageVirtualMachineCommandOutput | UpdateVolumeCommandOutput;
|
|
46
|
+
export declare type ServiceInputTypes = AssociateFileSystemAliasesCommandInput | CancelDataRepositoryTaskCommandInput | CopyBackupCommandInput | CreateBackupCommandInput | CreateDataRepositoryAssociationCommandInput | CreateDataRepositoryTaskCommandInput | CreateFileSystemCommandInput | CreateFileSystemFromBackupCommandInput | CreateSnapshotCommandInput | CreateStorageVirtualMachineCommandInput | CreateVolumeCommandInput | CreateVolumeFromBackupCommandInput | DeleteBackupCommandInput | DeleteDataRepositoryAssociationCommandInput | DeleteFileSystemCommandInput | DeleteSnapshotCommandInput | DeleteStorageVirtualMachineCommandInput | DeleteVolumeCommandInput | DescribeBackupsCommandInput | DescribeDataRepositoryAssociationsCommandInput | DescribeDataRepositoryTasksCommandInput | DescribeFileSystemAliasesCommandInput | DescribeFileSystemsCommandInput | DescribeSnapshotsCommandInput | DescribeStorageVirtualMachinesCommandInput | DescribeVolumesCommandInput | DisassociateFileSystemAliasesCommandInput | ListTagsForResourceCommandInput | ReleaseFileSystemNfsV3LocksCommandInput | RestoreVolumeFromSnapshotCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDataRepositoryAssociationCommandInput | UpdateFileSystemCommandInput | UpdateSnapshotCommandInput | UpdateStorageVirtualMachineCommandInput | UpdateVolumeCommandInput;
|
|
47
|
+
export declare type ServiceOutputTypes = AssociateFileSystemAliasesCommandOutput | CancelDataRepositoryTaskCommandOutput | CopyBackupCommandOutput | CreateBackupCommandOutput | CreateDataRepositoryAssociationCommandOutput | CreateDataRepositoryTaskCommandOutput | CreateFileSystemCommandOutput | CreateFileSystemFromBackupCommandOutput | CreateSnapshotCommandOutput | CreateStorageVirtualMachineCommandOutput | CreateVolumeCommandOutput | CreateVolumeFromBackupCommandOutput | DeleteBackupCommandOutput | DeleteDataRepositoryAssociationCommandOutput | DeleteFileSystemCommandOutput | DeleteSnapshotCommandOutput | DeleteStorageVirtualMachineCommandOutput | DeleteVolumeCommandOutput | DescribeBackupsCommandOutput | DescribeDataRepositoryAssociationsCommandOutput | DescribeDataRepositoryTasksCommandOutput | DescribeFileSystemAliasesCommandOutput | DescribeFileSystemsCommandOutput | DescribeSnapshotsCommandOutput | DescribeStorageVirtualMachinesCommandOutput | DescribeVolumesCommandOutput | DisassociateFileSystemAliasesCommandOutput | ListTagsForResourceCommandOutput | ReleaseFileSystemNfsV3LocksCommandOutput | RestoreVolumeFromSnapshotCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDataRepositoryAssociationCommandOutput | UpdateFileSystemCommandOutput | UpdateSnapshotCommandOutput | UpdateStorageVirtualMachineCommandOutput | UpdateVolumeCommandOutput;
|
|
38
48
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
39
49
|
/**
|
|
40
50
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -10,24 +10,24 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
|
|
|
10
10
|
* <p>Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region
|
|
11
11
|
* (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five
|
|
12
12
|
* backup copy requests in progress to a single destination Region per account.</p>
|
|
13
|
-
* <p>You can use cross-Region backup copies for cross-
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <
|
|
19
|
-
*
|
|
13
|
+
* <p>You can use cross-Region backup copies for cross-Region disaster recovery. You can
|
|
14
|
+
* periodically take backups and copy them to another Region so that in the event of a
|
|
15
|
+
* disaster in the primary Region, you can restore from backup and recover availability
|
|
16
|
+
* quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently
|
|
17
|
+
* has three partitions: <code>aws</code> (Standard Regions), <code>aws-cn</code> (China
|
|
18
|
+
* Regions), and <code>aws-us-gov</code> (Amazon Web Services GovCloud [US] Regions).</p>
|
|
19
|
+
* <p>You can also use backup copies to clone your file dataset to another Region or within
|
|
20
|
+
* the same Region.</p>
|
|
20
21
|
* <p>You can use the <code>SourceRegion</code> parameter to specify the Amazon Web Services Region
|
|
21
22
|
* from which the backup will be copied. For example, if you make the call from the
|
|
22
23
|
* <code>us-west-1</code> Region and want to copy a backup from the <code>us-east-2</code>
|
|
23
24
|
* Region, you specify <code>us-east-2</code> in the <code>SourceRegion</code> parameter
|
|
24
25
|
* to make a cross-Region copy. If you don't specify a Region, the backup copy is
|
|
25
26
|
* created in the same Region where the request is sent from (in-Region copy).</p>
|
|
26
|
-
* <p>For more information
|
|
27
|
-
* <a href="https://docs.aws.amazon.com/fsx/latest/
|
|
28
|
-
* Copying backups</a> in the <i>Amazon FSx for
|
|
29
|
-
*
|
|
30
|
-
* in the <i>Amazon FSx for Lustre User Guide</i>.</p>
|
|
27
|
+
* <p>For more information about creating backup copies, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups"> Copying backups</a>
|
|
28
|
+
* in the <i>Amazon FSx for Windows User Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups">Copying backups</a> in the <i>Amazon FSx for Lustre User
|
|
29
|
+
* Guide</i>, and <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups">Copying backups</a> in the <i>Amazon FSx for OpenZFS User
|
|
30
|
+
* Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -7,42 +7,44 @@ export interface CreateBackupCommandInput extends CreateBackupRequest {
|
|
|
7
7
|
export interface CreateBackupCommandOutput extends CreateBackupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a backup of an existing Amazon FSx for Windows File Server
|
|
11
|
-
*
|
|
12
|
-
* volume
|
|
13
|
-
* a file system or volume from a backup if an issue arises
|
|
14
|
-
* file system or volume.</p>
|
|
15
|
-
* <p>For Amazon FSx for Lustre file systems, you can create a backup only
|
|
16
|
-
*
|
|
10
|
+
* <p>Creates a backup of an existing Amazon FSx for Windows File Server file
|
|
11
|
+
* system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP
|
|
12
|
+
* volume, or Amazon FSx for OpenZFS file system. We recommend creating regular
|
|
13
|
+
* backups so that you can restore a file system or volume from a backup if an issue arises
|
|
14
|
+
* with the original file system or volume.</p>
|
|
15
|
+
* <p>For Amazon FSx for Lustre file systems, you can create a backup only for file
|
|
16
|
+
* systems that have the following configuration:</p>
|
|
17
17
|
* <ul>
|
|
18
18
|
* <li>
|
|
19
|
-
* <p>
|
|
19
|
+
* <p>A Persistent deployment type</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
* <p>
|
|
22
|
+
* <p>Are <i>not</i> linked to a data repository</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* </ul>
|
|
25
25
|
* <p>For more information about backups, see the following:</p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* <p>For Amazon FSx for Lustre, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html">Working with FSx for
|
|
29
|
+
* Lustre backups</a>.</p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p>For Amazon FSx for Windows, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html">Working with FSx for
|
|
33
|
+
* Windows backups</a>.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
37
|
-
*
|
|
36
|
+
* <p>For Amazon FSx for NetApp ONTAP, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html">Working with FSx for NetApp
|
|
37
|
+
* ONTAP backups</a>.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>For Amazon FSx for OpenZFS, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html">Working with FSx for OpenZFS backups</a>.</p>
|
|
38
41
|
* </li>
|
|
39
42
|
* </ul>
|
|
40
|
-
* <p>If a backup with the specified client request token exists
|
|
41
|
-
*
|
|
42
|
-
* specified client request token exists
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* following: </p>
|
|
43
|
+
* <p>If a backup with the specified client request token exists and the parameters match,
|
|
44
|
+
* this operation returns the description of the existing backup. If a backup with the
|
|
45
|
+
* specified client request token exists and the parameters don't match, this operation
|
|
46
|
+
* returns <code>IncompatibleParameterError</code>. If a backup with the specified client
|
|
47
|
+
* request token doesn't exist, <code>CreateBackup</code> does the following: </p>
|
|
46
48
|
* <ul>
|
|
47
49
|
* <li>
|
|
48
50
|
* <p>Creates a new Amazon FSx backup with an assigned ID, and an initial
|
|
@@ -59,10 +61,10 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
|
|
|
59
61
|
* you use the same client request token and the initial call created a backup, the
|
|
60
62
|
* operation returns a successful result because all the parameters are the same.</p>
|
|
61
63
|
*
|
|
62
|
-
* <p>The <code>CreateBackup</code> operation returns while the backup's
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
64
|
+
* <p>The <code>CreateBackup</code> operation returns while the backup's lifecycle state is
|
|
65
|
+
* still <code>CREATING</code>. You can check the backup creation status by calling the
|
|
66
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html">DescribeBackups</a> operation, which returns the backup state along with other
|
|
67
|
+
* information.</p>
|
|
66
68
|
* @example
|
|
67
69
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
70
|
* ```javascript
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
|
|
4
|
+
import { CreateDataRepositoryAssociationRequest, CreateDataRepositoryAssociationResponse } from "../models/models_0";
|
|
5
|
+
export interface CreateDataRepositoryAssociationCommandInput extends CreateDataRepositoryAssociationRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateDataRepositoryAssociationCommandOutput extends CreateDataRepositoryAssociationResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates an Amazon FSx for Lustre data repository association (DRA). A data
|
|
11
|
+
* repository association is a link between a directory on the file system and
|
|
12
|
+
* an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository
|
|
13
|
+
* associations on a file system. Data repository associations are supported only
|
|
14
|
+
* for file systems with the <code>Persistent_2</code> deployment type.</p>
|
|
15
|
+
* <p>Each data repository association must have a unique Amazon FSx file
|
|
16
|
+
* system directory and a unique S3 bucket or prefix associated with it. You
|
|
17
|
+
* can configure a data repository association for automatic import only,
|
|
18
|
+
* for automatic export only, or for both. To learn more about linking a
|
|
19
|
+
* data repository to your file system, see
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html">Linking your file system to an S3 bucket</a>.</p>
|
|
21
|
+
* @example
|
|
22
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
23
|
+
* ```javascript
|
|
24
|
+
* import { FSxClient, CreateDataRepositoryAssociationCommand } from "@aws-sdk/client-fsx"; // ES Modules import
|
|
25
|
+
* // const { FSxClient, CreateDataRepositoryAssociationCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
|
|
26
|
+
* const client = new FSxClient(config);
|
|
27
|
+
* const command = new CreateDataRepositoryAssociationCommand(input);
|
|
28
|
+
* const response = await client.send(command);
|
|
29
|
+
* ```
|
|
30
|
+
*
|
|
31
|
+
* @see {@link CreateDataRepositoryAssociationCommandInput} for command's `input` shape.
|
|
32
|
+
* @see {@link CreateDataRepositoryAssociationCommandOutput} for command's `response` shape.
|
|
33
|
+
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class CreateDataRepositoryAssociationCommand extends $Command<CreateDataRepositoryAssociationCommandInput, CreateDataRepositoryAssociationCommandOutput, FSxClientResolvedConfig> {
|
|
37
|
+
readonly input: CreateDataRepositoryAssociationCommandInput;
|
|
38
|
+
constructor(input: CreateDataRepositoryAssociationCommandInput);
|
|
39
|
+
/**
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataRepositoryAssociationCommandInput, CreateDataRepositoryAssociationCommandOutput>;
|
|
43
|
+
private serialize;
|
|
44
|
+
private deserialize;
|
|
45
|
+
}
|
|
@@ -9,13 +9,14 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates an Amazon FSx for Lustre data repository task. You use data repository tasks
|
|
11
11
|
* to perform bulk operations between your Amazon FSx file system and its linked data
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* linked to the FSx file system. To learn
|
|
12
|
+
* repositories. An example of a data repository task is exporting any data and metadata
|
|
13
|
+
* changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)
|
|
14
|
+
* from your FSx file system to a linked data repository. A <code>CreateDataRepositoryTask</code>
|
|
15
|
+
* operation will fail if a data repository is not linked to the FSx file system. To learn
|
|
16
|
+
* more about data repository tasks, see
|
|
16
17
|
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html">Data Repository Tasks</a>.
|
|
17
18
|
* To learn more about linking a data repository to your file system, see
|
|
18
|
-
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-
|
|
19
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html">Linking your file system to an S3 bucket</a>.</p>
|
|
19
20
|
* @example
|
|
20
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
22
|
* ```javascript
|
|
@@ -7,24 +7,19 @@ export interface CreateFileSystemCommandInput extends CreateFileSystemRequest {
|
|
|
7
7
|
export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new, empty Amazon FSx file system
|
|
11
|
-
*
|
|
12
|
-
* <p>If a file system with the specified client request token exists and the parameters
|
|
13
|
-
* match, <code>CreateFileSystem</code> returns the description of the existing file
|
|
14
|
-
* system. If a file system specified client request token exists and the parameters
|
|
15
|
-
* don't match, this call returns <code>IncompatibleParameterError</code>. If a file
|
|
16
|
-
* system with the specified client request token doesn't exist,
|
|
17
|
-
* <code>CreateFileSystem</code> does the following: </p>
|
|
10
|
+
* <p>Creates a new, empty Amazon FSx file system. You can create the following supported
|
|
11
|
+
* Amazon FSx file systems using the <code>CreateFileSystem</code> API operation:</p>
|
|
18
12
|
* <ul>
|
|
19
13
|
* <li>
|
|
20
|
-
*
|
|
21
|
-
* initial lifecycle state of <code>CREATING</code>.</p>
|
|
14
|
+
* <p>Amazon FSx for Lustre</p>
|
|
22
15
|
* </li>
|
|
23
16
|
* <li>
|
|
24
|
-
*
|
|
17
|
+
* <p>Amazon FSx for NetApp ONTAP</p>
|
|
18
|
+
* </li>
|
|
19
|
+
* <li>
|
|
20
|
+
* <p>Amazon FSx for Windows File Server</p>
|
|
25
21
|
* </li>
|
|
26
22
|
* </ul>
|
|
27
|
-
*
|
|
28
23
|
* <p>This operation requires a client request token in the request that Amazon FSx uses
|
|
29
24
|
* to ensure idempotent creation. This means that calling the operation multiple times with
|
|
30
25
|
* the same client request token has no effect. By using the idempotent operation, you can
|
|
@@ -34,11 +29,36 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
|
|
|
34
29
|
* occurred, or your connection was reset. If you use the same client request token and the
|
|
35
30
|
* initial call created a file system, the client receives success as long as the
|
|
36
31
|
* parameters are the same.</p>
|
|
32
|
+
* <p>If a file system with the specified client request token exists and the parameters
|
|
33
|
+
* match, <code>CreateFileSystem</code> returns the description of the existing file
|
|
34
|
+
* system. If a file system with the specified client request token exists and the
|
|
35
|
+
* parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a
|
|
36
|
+
* file system with the specified client request token doesn't exist,
|
|
37
|
+
* <code>CreateFileSystem</code> does the following: </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>Creates a new, empty Amazon FSx file system with an assigned ID, and
|
|
41
|
+
* an initial lifecycle state of <code>CREATING</code>.</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>Returns the description of the file system.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
*
|
|
48
|
+
* <p>This operation requires a client request token in the request that Amazon FSx
|
|
49
|
+
* uses to ensure idempotent creation. This means that calling the operation multiple times
|
|
50
|
+
* with the same client request token has no effect. By using the idempotent operation, you
|
|
51
|
+
* can retry a <code>CreateFileSystem</code> operation without the risk of creating an
|
|
52
|
+
* extra file system. This approach can be useful when an initial call fails in a way that
|
|
53
|
+
* makes it unclear whether a file system was created. Examples are if a transport-level
|
|
54
|
+
* timeout occurred, or your connection was reset. If you use the same client request token
|
|
55
|
+
* and the initial call created a file system, the client receives a success message as
|
|
56
|
+
* long as the parameters are the same.</p>
|
|
37
57
|
* <note>
|
|
38
|
-
* <p>The <code>CreateFileSystem</code> call returns while the file system's
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
58
|
+
* <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle
|
|
59
|
+
* state is still <code>CREATING</code>. You can check the file-system creation status
|
|
60
|
+
* by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns the file system state
|
|
61
|
+
* along with other information.</p>
|
|
42
62
|
* </note>
|
|
43
63
|
* @example
|
|
44
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,26 +7,26 @@ export interface CreateFileSystemFromBackupCommandInput extends CreateFileSystem
|
|
|
7
7
|
export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSystemFromBackupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new Amazon FSx for Lustre
|
|
11
|
-
* from an existing Amazon FSx backup.</p>
|
|
10
|
+
* <p>Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File
|
|
11
|
+
* Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.</p>
|
|
12
12
|
*
|
|
13
13
|
* <p>If a file system with the specified client request token exists and the parameters
|
|
14
|
-
* match, this operation returns the description of the file system. If a client
|
|
15
|
-
*
|
|
16
|
-
*
|
|
14
|
+
* match, this operation returns the description of the file system. If a client request
|
|
15
|
+
* token with the specified by the file system exists and the parameters don't match, this
|
|
16
|
+
* call returns <code>IncompatibleParameterError</code>. If a file system with the
|
|
17
17
|
* specified client request token doesn't exist, this operation does the following:</p>
|
|
18
18
|
*
|
|
19
19
|
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
* <p>Creates a new Amazon FSx file system from backup with an assigned ID,
|
|
22
|
-
* an initial lifecycle state of <code>CREATING</code>.</p>
|
|
21
|
+
* <p>Creates a new Amazon FSx file system from backup with an assigned ID,
|
|
22
|
+
* and an initial lifecycle state of <code>CREATING</code>.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
25
|
* <p>Returns the description of the file system.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* </ul>
|
|
28
28
|
*
|
|
29
|
-
* <p>Parameters like Active Directory, default share name, automatic backup, and backup
|
|
29
|
+
* <p>Parameters like the Active Directory, default share name, automatic backup, and backup
|
|
30
30
|
* settings default to the parameters of the file system that was backed up, unless
|
|
31
31
|
* overridden. You can explicitly supply other settings.</p>
|
|
32
32
|
*
|
|
@@ -35,14 +35,14 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
|
|
|
35
35
|
* file system. This approach can be useful when an initial call fails in a way that makes
|
|
36
36
|
* it unclear whether a file system was created. Examples are if a transport level timeout
|
|
37
37
|
* occurred, or your connection was reset. If you use the same client request token and the
|
|
38
|
-
* initial call created a file system, the client receives success as long as the
|
|
38
|
+
* initial call created a file system, the client receives a success message as long as the
|
|
39
39
|
* parameters are the same.</p>
|
|
40
40
|
* <note>
|
|
41
|
-
* <p>The <code>CreateFileSystemFromBackup</code> call returns while the file
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* information.</p>
|
|
41
|
+
* <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's
|
|
42
|
+
* lifecycle state is still <code>CREATING</code>. You can check the file-system
|
|
43
|
+
* creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">
|
|
44
|
+
* DescribeFileSystems</a> operation, which returns the file system state along
|
|
45
|
+
* with other information.</p>
|
|
46
46
|
* </note>
|
|
47
47
|
* @example
|
|
48
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
|
|
4
|
+
import { CreateSnapshotRequest, CreateSnapshotResponse } from "../models/models_0";
|
|
5
|
+
export interface CreateSnapshotCommandInput extends CreateSnapshotRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With
|
|
11
|
+
* snapshots, you can easily undo file changes and compare file versions by restoring the
|
|
12
|
+
* volume to a previous version.</p>
|
|
13
|
+
* <p>If a snapshot with the specified client request token exists, and the parameters
|
|
14
|
+
* match, this operation returns the description of the existing snapshot. If a snapshot
|
|
15
|
+
* with the specified client request token exists, and the parameters don't match, this
|
|
16
|
+
* operation returns <code>IncompatibleParameterError</code>. If a snapshot with the
|
|
17
|
+
* specified client request token doesn't exist, <code>CreateSnapshot</code> does the
|
|
18
|
+
* following: </p>
|
|
19
|
+
* <ul>
|
|
20
|
+
* <li>
|
|
21
|
+
* <p>Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle
|
|
22
|
+
* state of <code>CREATING</code>.</p>
|
|
23
|
+
* </li>
|
|
24
|
+
* <li>
|
|
25
|
+
* <p>Returns the description of the snapshot.</p>
|
|
26
|
+
* </li>
|
|
27
|
+
* </ul>
|
|
28
|
+
* <p>By using the idempotent operation, you can retry a <code>CreateSnapshot</code>
|
|
29
|
+
* operation without the risk of creating an extra snapshot. This approach can be useful
|
|
30
|
+
* when an initial call fails in a way that makes it unclear whether a snapshot was
|
|
31
|
+
* created. If you use the same client request token and the initial call created a
|
|
32
|
+
* snapshot, the operation returns a successful result because all the parameters are the
|
|
33
|
+
* same.</p>
|
|
34
|
+
* <p>The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state
|
|
35
|
+
* is still <code>CREATING</code>. You can check the snapshot creation status by calling
|
|
36
|
+
* the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a> operation, which returns the snapshot state along with
|
|
37
|
+
* other information. </p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { FSxClient, CreateSnapshotCommand } from "@aws-sdk/client-fsx"; // ES Modules import
|
|
42
|
+
* // const { FSxClient, CreateSnapshotCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
|
|
43
|
+
* const client = new FSxClient(config);
|
|
44
|
+
* const command = new CreateSnapshotCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @see {@link CreateSnapshotCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
*/
|
|
53
|
+
export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, FSxClientResolvedConfig> {
|
|
54
|
+
readonly input: CreateSnapshotCommandInput;
|
|
55
|
+
constructor(input: CreateSnapshotCommandInput);
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
*/
|
|
59
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSnapshotCommandInput, CreateSnapshotCommandOutput>;
|
|
60
|
+
private serialize;
|
|
61
|
+
private deserialize;
|
|
62
|
+
}
|
|
@@ -7,7 +7,8 @@ export interface CreateVolumeCommandInput extends CreateVolumeRequest {
|
|
|
7
7
|
export interface CreateVolumeCommandOutput extends CreateVolumeResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an Amazon FSx for NetApp ONTAP storage
|
|
10
|
+
* <p>Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage
|
|
11
|
+
* volume.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,10 +7,11 @@ export interface DeleteBackupCommandInput extends DeleteBackupRequest {
|
|
|
7
7
|
export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an Amazon FSx backup
|
|
10
|
+
* <p>Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and
|
|
11
|
+
* its data is gone.</p>
|
|
11
12
|
*
|
|
12
|
-
* <p>The <code>DeleteBackup</code> call returns instantly. The backup
|
|
13
|
-
*
|
|
13
|
+
* <p>The <code>DeleteBackup</code> call returns instantly. The backup won't show up in
|
|
14
|
+
* later <code>DescribeBackups</code> calls.</p>
|
|
14
15
|
*
|
|
15
16
|
* <important>
|
|
16
17
|
* <p>The data in a deleted backup is also deleted and can't be recovered by any
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
|
|
4
|
+
import { DeleteDataRepositoryAssociationRequest, DeleteDataRepositoryAssociationResponse } from "../models/models_0";
|
|
5
|
+
export interface DeleteDataRepositoryAssociationCommandInput extends DeleteDataRepositoryAssociationRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DeleteDataRepositoryAssociationCommandOutput extends DeleteDataRepositoryAssociationResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes a data repository association on an Amazon FSx for Lustre
|
|
11
|
+
* file system. Deleting the data repository association unlinks the
|
|
12
|
+
* file system from the Amazon S3 bucket. When deleting a data repository
|
|
13
|
+
* association, you have the option of deleting the data in the file system
|
|
14
|
+
* that corresponds to the data repository association. Data repository
|
|
15
|
+
* associations are supported only for file systems with the
|
|
16
|
+
* <code>Persistent_2</code> deployment type.</p>
|
|
17
|
+
* @example
|
|
18
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
19
|
+
* ```javascript
|
|
20
|
+
* import { FSxClient, DeleteDataRepositoryAssociationCommand } from "@aws-sdk/client-fsx"; // ES Modules import
|
|
21
|
+
* // const { FSxClient, DeleteDataRepositoryAssociationCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
|
|
22
|
+
* const client = new FSxClient(config);
|
|
23
|
+
* const command = new DeleteDataRepositoryAssociationCommand(input);
|
|
24
|
+
* const response = await client.send(command);
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* @see {@link DeleteDataRepositoryAssociationCommandInput} for command's `input` shape.
|
|
28
|
+
* @see {@link DeleteDataRepositoryAssociationCommandOutput} for command's `response` shape.
|
|
29
|
+
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
export declare class DeleteDataRepositoryAssociationCommand extends $Command<DeleteDataRepositoryAssociationCommandInput, DeleteDataRepositoryAssociationCommandOutput, FSxClientResolvedConfig> {
|
|
33
|
+
readonly input: DeleteDataRepositoryAssociationCommandInput;
|
|
34
|
+
constructor(input: DeleteDataRepositoryAssociationCommandInput);
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDataRepositoryAssociationCommandInput, DeleteDataRepositoryAssociationCommandOutput>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -7,27 +7,26 @@ export interface DeleteFileSystemCommandInput extends DeleteFileSystemRequest {
|
|
|
7
7
|
export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a file system
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <code>DeleFileSystem</code> operation.</p>
|
|
10
|
+
* <p>Deletes a file system. After deletion, the file system no longer exists, and its data
|
|
11
|
+
* is gone. Any existing automatic backups and snapshots are also deleted.</p>
|
|
12
|
+
* <p>To delete an Amazon FSx for NetApp ONTAP file system, first delete all the
|
|
13
|
+
* volumes and storage virtual machines (SVMs) on the file system. Then provide a
|
|
14
|
+
* <code>FileSystemId</code> value to the <code>DeleFileSystem</code> operation.</p>
|
|
16
15
|
*
|
|
17
|
-
* <p>By default, when you delete an Amazon FSx for Windows File Server file system,
|
|
18
|
-
* final backup is created upon deletion. This final backup
|
|
16
|
+
* <p>By default, when you delete an Amazon FSx for Windows File Server file system,
|
|
17
|
+
* a final backup is created upon deletion. This final backup isn't subject to the file
|
|
19
18
|
* system's retention policy, and must be manually deleted.</p>
|
|
20
19
|
*
|
|
21
|
-
* <p>The <code>DeleteFileSystem</code>
|
|
20
|
+
* <p>The <code>DeleteFileSystem</code> operation returns while the file system has the
|
|
22
21
|
* <code>DELETING</code> status. You can check the file system deletion status by
|
|
23
|
-
* calling the <a>DescribeFileSystems</a>
|
|
24
|
-
*
|
|
25
|
-
* <
|
|
22
|
+
* calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns a list of file systems in your
|
|
23
|
+
* account. If you pass the file system ID for a deleted file system, the
|
|
24
|
+
* <code>DescribeFileSystems</code> operation returns a <code>FileSystemNotFound</code>
|
|
26
25
|
* error.</p>
|
|
27
26
|
* <note>
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
27
|
+
* <p>If a data repository task is in a <code>PENDING</code> or <code>EXECUTING</code> state,
|
|
28
|
+
* deleting an Amazon FSx for Lustre file system will fail with an HTTP status
|
|
29
|
+
* code 400 (Bad Request).</p>
|
|
31
30
|
* </note>
|
|
32
31
|
* <important>
|
|
33
32
|
* <p>The data in a deleted file system is also deleted and can't be recovered by
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
|
|
4
|
+
import { DeleteSnapshotRequest, DeleteSnapshotResponse } from "../models/models_0";
|
|
5
|
+
export interface DeleteSnapshotCommandInput extends DeleteSnapshotRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer
|
|
11
|
+
* exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a
|
|
12
|
+
* file system backup. </p>
|
|
13
|
+
* <p>The <code>DeleteSnapshot</code> operation returns instantly. The snapshot appears with
|
|
14
|
+
* the lifecycle status of <code>DELETING</code> until the deletion is complete.</p>
|
|
15
|
+
* @example
|
|
16
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
17
|
+
* ```javascript
|
|
18
|
+
* import { FSxClient, DeleteSnapshotCommand } from "@aws-sdk/client-fsx"; // ES Modules import
|
|
19
|
+
* // const { FSxClient, DeleteSnapshotCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
|
|
20
|
+
* const client = new FSxClient(config);
|
|
21
|
+
* const command = new DeleteSnapshotCommand(input);
|
|
22
|
+
* const response = await client.send(command);
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @see {@link DeleteSnapshotCommandInput} for command's `input` shape.
|
|
26
|
+
* @see {@link DeleteSnapshotCommandOutput} for command's `response` shape.
|
|
27
|
+
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
export declare class DeleteSnapshotCommand extends $Command<DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput, FSxClientResolvedConfig> {
|
|
31
|
+
readonly input: DeleteSnapshotCommandInput;
|
|
32
|
+
constructor(input: DeleteSnapshotCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|