@aws-sdk/client-fsx 3.288.0 → 3.289.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/dist-types/commands/CopyBackupCommand.d.ts +44 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +46 -0
- package/dist-types/commands/CreateFileSystemCommand.d.ts +75 -0
- package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +58 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +17 -0
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +17 -0
- package/dist-types/commands/DescribeBackupsCommand.d.ts +39 -0
- package/dist-types/commands/DescribeFileSystemsCommand.d.ts +45 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
- package/dist-types/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
- package/dist-types/commands/UpdateFileSystemCommand.d.ts +46 -0
- package/package.json +29 -29
|
@@ -49,6 +49,50 @@ 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
|
+
* @example To copy a backup
|
|
53
|
+
* ```javascript
|
|
54
|
+
* // This operation copies an Amazon FSx backup.
|
|
55
|
+
* const input = {
|
|
56
|
+
* "SourceBackupId": "backup-03e3c82e0183b7b6b",
|
|
57
|
+
* "SourceRegion": "us-east-2"
|
|
58
|
+
* };
|
|
59
|
+
* const command = new CopyBackupCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* /* response ==
|
|
62
|
+
* {
|
|
63
|
+
* "Backup": {
|
|
64
|
+
* "BackupId": "backup-0a3364eded1014b28",
|
|
65
|
+
* "CreationTime": 1617954808.068,
|
|
66
|
+
* "FileSystem": {
|
|
67
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
68
|
+
* "FileSystemType": "LUSTRE",
|
|
69
|
+
* "LustreConfiguration": {
|
|
70
|
+
* "AutomaticBackupRetentionDays": 0,
|
|
71
|
+
* "DeploymentType": "PERSISTENT_1",
|
|
72
|
+
* "PerUnitStorageThroughput": 50,
|
|
73
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
74
|
+
* },
|
|
75
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66",
|
|
76
|
+
* "StorageCapacity": 2400,
|
|
77
|
+
* "StorageType": "SSD"
|
|
78
|
+
* },
|
|
79
|
+
* "KmsKeyId": "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a",
|
|
80
|
+
* "Lifecycle": "COPYING",
|
|
81
|
+
* "OwnerId": "123456789012",
|
|
82
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28",
|
|
83
|
+
* "Tags": [
|
|
84
|
+
* {
|
|
85
|
+
* "Key": "Name",
|
|
86
|
+
* "Value": "MyBackup"
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "Type": "USER_INITIATED"
|
|
90
|
+
* }
|
|
91
|
+
* }
|
|
92
|
+
* *\/
|
|
93
|
+
* // example id: to-copy-a-backup-1481847318640
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
52
96
|
*/
|
|
53
97
|
export declare class CopyBackupCommand extends $Command<CopyBackupCommandInput, CopyBackupCommandOutput, FSxClientResolvedConfig> {
|
|
54
98
|
readonly input: CopyBackupCommandInput;
|
|
@@ -84,6 +84,52 @@ 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
|
+
* @example To create a new backup
|
|
88
|
+
* ```javascript
|
|
89
|
+
* // This operation creates a new backup.
|
|
90
|
+
* const input = {
|
|
91
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
92
|
+
* "Tags": [
|
|
93
|
+
* {
|
|
94
|
+
* "Key": "Name",
|
|
95
|
+
* "Value": "MyBackup"
|
|
96
|
+
* }
|
|
97
|
+
* ]
|
|
98
|
+
* };
|
|
99
|
+
* const command = new CreateBackupCommand(input);
|
|
100
|
+
* const response = await client.send(command);
|
|
101
|
+
* /* response ==
|
|
102
|
+
* {
|
|
103
|
+
* "Backup": {
|
|
104
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
105
|
+
* "CreationTime": "1481841524.0",
|
|
106
|
+
* "FileSystem": {
|
|
107
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
108
|
+
* "OwnerId": "012345678912",
|
|
109
|
+
* "StorageCapacity": 300,
|
|
110
|
+
* "WindowsConfiguration": {
|
|
111
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
112
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
113
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
114
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
115
|
+
* }
|
|
116
|
+
* },
|
|
117
|
+
* "Lifecycle": "CREATING",
|
|
118
|
+
* "ProgressPercent": 0,
|
|
119
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
|
|
120
|
+
* "Tags": [
|
|
121
|
+
* {
|
|
122
|
+
* "Key": "Name",
|
|
123
|
+
* "Value": "MyBackup"
|
|
124
|
+
* }
|
|
125
|
+
* ],
|
|
126
|
+
* "Type": "USER_INITIATED"
|
|
127
|
+
* }
|
|
128
|
+
* }
|
|
129
|
+
* *\/
|
|
130
|
+
* // example id: to-create-a-new-backup-1481840798597
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
87
133
|
*/
|
|
88
134
|
export declare class CreateBackupCommand extends $Command<CreateBackupCommandInput, CreateBackupCommandOutput, FSxClientResolvedConfig> {
|
|
89
135
|
readonly input: CreateBackupCommandInput;
|
|
@@ -74,6 +74,81 @@ 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
|
+
* @example To create a new file system
|
|
78
|
+
* ```javascript
|
|
79
|
+
* // This operation creates a new Amazon FSx for Windows File Server file system.
|
|
80
|
+
* const input = {
|
|
81
|
+
* "ClientRequestToken": "a8ca07e4-61ec-4399-99f4-19853801bcd5",
|
|
82
|
+
* "FileSystemType": "WINDOWS",
|
|
83
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff",
|
|
84
|
+
* "SecurityGroupIds": [
|
|
85
|
+
* "sg-edcd9784"
|
|
86
|
+
* ],
|
|
87
|
+
* "StorageCapacity": 3200,
|
|
88
|
+
* "StorageType": "HDD",
|
|
89
|
+
* "SubnetIds": [
|
|
90
|
+
* "subnet-1234abcd"
|
|
91
|
+
* ],
|
|
92
|
+
* "Tags": [
|
|
93
|
+
* {
|
|
94
|
+
* "Key": "Name",
|
|
95
|
+
* "Value": "MyFileSystem"
|
|
96
|
+
* }
|
|
97
|
+
* ],
|
|
98
|
+
* "WindowsConfiguration": {
|
|
99
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
100
|
+
* "Aliases": [
|
|
101
|
+
* "accounting.corp.example.com"
|
|
102
|
+
* ],
|
|
103
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
104
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
105
|
+
* "ThroughputCapacity": 32,
|
|
106
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
107
|
+
* }
|
|
108
|
+
* };
|
|
109
|
+
* const command = new CreateFileSystemCommand(input);
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response ==
|
|
112
|
+
* {
|
|
113
|
+
* "FileSystem": {
|
|
114
|
+
* "CreationTime": "1481841524.0",
|
|
115
|
+
* "DNSName": "fs-0123456789abcdef0.fsx.com",
|
|
116
|
+
* "FileSystemId": "fs-0123456789abcdef0",
|
|
117
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff",
|
|
118
|
+
* "Lifecycle": "CREATING",
|
|
119
|
+
* "OwnerId": "012345678912",
|
|
120
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0",
|
|
121
|
+
* "StorageCapacity": 3200,
|
|
122
|
+
* "StorageType": "HDD",
|
|
123
|
+
* "SubnetIds": [
|
|
124
|
+
* "subnet-1234abcd"
|
|
125
|
+
* ],
|
|
126
|
+
* "Tags": [
|
|
127
|
+
* {
|
|
128
|
+
* "Key": "Name",
|
|
129
|
+
* "Value": "MyFileSystem"
|
|
130
|
+
* }
|
|
131
|
+
* ],
|
|
132
|
+
* "VpcId": "vpc-ab1234cd",
|
|
133
|
+
* "WindowsConfiguration": {
|
|
134
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
135
|
+
* "Aliases": [
|
|
136
|
+
* {
|
|
137
|
+
* "Lifecycle": "CREATING",
|
|
138
|
+
* "Name": "accounting.corp.example.com"
|
|
139
|
+
* }
|
|
140
|
+
* ],
|
|
141
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
142
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
143
|
+
* "ThroughputCapacity": 32,
|
|
144
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
145
|
+
* }
|
|
146
|
+
* }
|
|
147
|
+
* }
|
|
148
|
+
* *\/
|
|
149
|
+
* // example id: to-create-a-new-file-system-1481840798547
|
|
150
|
+
* ```
|
|
151
|
+
*
|
|
77
152
|
*/
|
|
78
153
|
export declare class CreateFileSystemCommand extends $Command<CreateFileSystemCommandInput, CreateFileSystemCommandOutput, FSxClientResolvedConfig> {
|
|
79
154
|
readonly input: CreateFileSystemCommandInput;
|
|
@@ -61,6 +61,64 @@ 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
|
+
* @example To create a new file system from backup
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // This operation creates a new file system from backup.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
69
|
+
* "ClientRequestToken": "f4c94ed7-238d-4c46-93db-48cd62ec33b7",
|
|
70
|
+
* "SecurityGroupIds": [
|
|
71
|
+
* "sg-edcd9784"
|
|
72
|
+
* ],
|
|
73
|
+
* "SubnetIds": [
|
|
74
|
+
* "subnet-1234abcd"
|
|
75
|
+
* ],
|
|
76
|
+
* "Tags": [
|
|
77
|
+
* {
|
|
78
|
+
* "Key": "Name",
|
|
79
|
+
* "Value": "MyFileSystem"
|
|
80
|
+
* }
|
|
81
|
+
* ],
|
|
82
|
+
* "WindowsConfiguration": {
|
|
83
|
+
* "ThroughputCapacity": 8
|
|
84
|
+
* }
|
|
85
|
+
* };
|
|
86
|
+
* const command = new CreateFileSystemFromBackupCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response ==
|
|
89
|
+
* {
|
|
90
|
+
* "FileSystem": {
|
|
91
|
+
* "CreationTime": "1481841524.0",
|
|
92
|
+
* "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
|
93
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
94
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
|
95
|
+
* "Lifecycle": "CREATING",
|
|
96
|
+
* "OwnerId": "012345678912",
|
|
97
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
98
|
+
* "StorageCapacity": 300,
|
|
99
|
+
* "SubnetIds": [
|
|
100
|
+
* "subnet-1234abcd"
|
|
101
|
+
* ],
|
|
102
|
+
* "Tags": [
|
|
103
|
+
* {
|
|
104
|
+
* "Key": "Name",
|
|
105
|
+
* "Value": "MyFileSystem"
|
|
106
|
+
* }
|
|
107
|
+
* ],
|
|
108
|
+
* "VpcId": "vpc-ab1234cd",
|
|
109
|
+
* "WindowsConfiguration": {
|
|
110
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
111
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
112
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
113
|
+
* "ThroughputCapacity": 8,
|
|
114
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
115
|
+
* }
|
|
116
|
+
* }
|
|
117
|
+
* }
|
|
118
|
+
* *\/
|
|
119
|
+
* // example id: to-create-a-new-file-system-from-backup-1481840798598
|
|
120
|
+
* ```
|
|
121
|
+
*
|
|
64
122
|
*/
|
|
65
123
|
export declare class CreateFileSystemFromBackupCommand extends $Command<CreateFileSystemFromBackupCommandInput, CreateFileSystemFromBackupCommandOutput, FSxClientResolvedConfig> {
|
|
66
124
|
readonly input: CreateFileSystemFromBackupCommandInput;
|
|
@@ -36,6 +36,23 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad
|
|
|
36
36
|
* @see {@link DeleteBackupCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @example To delete a backup
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // This operation deletes an Amazon FSx file system backup.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "BackupId": "backup-03e3c82e0183b7b6b"
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DeleteBackupCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
50
|
+
* "Lifecycle": "DELETED"
|
|
51
|
+
* }
|
|
52
|
+
* *\/
|
|
53
|
+
* // example id: to-delete-a-file-system-1481847318399
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
39
56
|
*/
|
|
40
57
|
export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, FSxClientResolvedConfig> {
|
|
41
58
|
readonly input: DeleteBackupCommandInput;
|
|
@@ -51,6 +51,23 @@ export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse,
|
|
|
51
51
|
* @see {@link DeleteFileSystemCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @example To delete a file system
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // This operation deletes an Amazon FSx file system.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "FileSystemId": "fs-0498eed5fe91001ec"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new DeleteFileSystemCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* /* response ==
|
|
63
|
+
* {
|
|
64
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
65
|
+
* "Lifecycle": "DELETING"
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-delete-a-file-system-1481847318348
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
54
71
|
*/
|
|
55
72
|
export declare class DeleteFileSystemCommand extends $Command<DeleteFileSystemCommandInput, DeleteFileSystemCommandOutput, FSxClientResolvedConfig> {
|
|
56
73
|
readonly input: DeleteFileSystemCommandInput;
|
|
@@ -54,6 +54,45 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
|
|
|
54
54
|
* @see {@link DescribeBackupsCommandOutput} for command's `response` shape.
|
|
55
55
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
56
56
|
*
|
|
57
|
+
* @example To describe Amazon FSx backups
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // This operation describes all of the Amazon FSx backups in an account.
|
|
60
|
+
* const input = {};
|
|
61
|
+
* const command = new DescribeBackupsCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* /* response ==
|
|
64
|
+
* {
|
|
65
|
+
* "Backups": [
|
|
66
|
+
* {
|
|
67
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
68
|
+
* "CreationTime": "1481841524.0",
|
|
69
|
+
* "FileSystem": {
|
|
70
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
71
|
+
* "OwnerId": "012345678912",
|
|
72
|
+
* "StorageCapacity": 300,
|
|
73
|
+
* "WindowsConfiguration": {
|
|
74
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
75
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
76
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
77
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
78
|
+
* }
|
|
79
|
+
* },
|
|
80
|
+
* "Lifecycle": "AVAILABLE",
|
|
81
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
|
|
82
|
+
* "Tags": [
|
|
83
|
+
* {
|
|
84
|
+
* "Key": "Name",
|
|
85
|
+
* "Value": "MyBackup"
|
|
86
|
+
* }
|
|
87
|
+
* ],
|
|
88
|
+
* "Type": "USER_INITIATED"
|
|
89
|
+
* }
|
|
90
|
+
* ]
|
|
91
|
+
* }
|
|
92
|
+
* *\/
|
|
93
|
+
* // example id: to-describe-backups-1481848448499
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
57
96
|
*/
|
|
58
97
|
export declare class DescribeBackupsCommand extends $Command<DescribeBackupsCommandInput, DescribeBackupsCommandOutput, FSxClientResolvedConfig> {
|
|
59
98
|
readonly input: DescribeBackupsCommandInput;
|
|
@@ -56,6 +56,51 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
|
|
|
56
56
|
* @see {@link DescribeFileSystemsCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @example To describe an Amazon FSx file system
|
|
60
|
+
* ```javascript
|
|
61
|
+
* // This operation describes all of the Amazon FSx file systems in an account.
|
|
62
|
+
* const input = {};
|
|
63
|
+
* const command = new DescribeFileSystemsCommand(input);
|
|
64
|
+
* const response = await client.send(command);
|
|
65
|
+
* /* response ==
|
|
66
|
+
* {
|
|
67
|
+
* "FileSystems": [
|
|
68
|
+
* {
|
|
69
|
+
* "CreationTime": "1481841524.0",
|
|
70
|
+
* "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
|
71
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
72
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
|
73
|
+
* "Lifecycle": "AVAILABLE",
|
|
74
|
+
* "NetworkInterfaceIds": [
|
|
75
|
+
* "eni-abcd1234"
|
|
76
|
+
* ],
|
|
77
|
+
* "OwnerId": "012345678912",
|
|
78
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
79
|
+
* "StorageCapacity": 300,
|
|
80
|
+
* "SubnetIds": [
|
|
81
|
+
* "subnet-1234abcd"
|
|
82
|
+
* ],
|
|
83
|
+
* "Tags": [
|
|
84
|
+
* {
|
|
85
|
+
* "Key": "Name",
|
|
86
|
+
* "Value": "MyFileSystem"
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "VpcId": "vpc-ab1234cd",
|
|
90
|
+
* "WindowsConfiguration": {
|
|
91
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
92
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
93
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
94
|
+
* "ThroughputCapacity": 8,
|
|
95
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
96
|
+
* }
|
|
97
|
+
* }
|
|
98
|
+
* ]
|
|
99
|
+
* }
|
|
100
|
+
* *\/
|
|
101
|
+
* // example id: to-describe-a-file-systems-1481848448460
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
59
104
|
*/
|
|
60
105
|
export declare class DescribeFileSystemsCommand extends $Command<DescribeFileSystemsCommandInput, DescribeFileSystemsCommandOutput, FSxClientResolvedConfig> {
|
|
61
106
|
readonly input: DescribeFileSystemsCommandInput;
|
|
@@ -52,6 +52,27 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
52
52
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
53
53
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
54
54
|
*
|
|
55
|
+
* @example To list tags for a resource
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // This operation lists tags for an Amazon FSx resource.
|
|
58
|
+
* const input = {
|
|
59
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* /* response ==
|
|
64
|
+
* {
|
|
65
|
+
* "Tags": [
|
|
66
|
+
* {
|
|
67
|
+
* "Key": "Name",
|
|
68
|
+
* "Value": "MyFileSystem"
|
|
69
|
+
* }
|
|
70
|
+
* ]
|
|
71
|
+
* }
|
|
72
|
+
* *\/
|
|
73
|
+
* // example id: to-list-tags-for-a-fsx-resource-1481847318372
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
55
76
|
*/
|
|
56
77
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, FSxClientResolvedConfig> {
|
|
57
78
|
readonly input: ListTagsForResourceCommandInput;
|
|
@@ -29,6 +29,23 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
29
29
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To tag a resource
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // This operation tags an Amazon FSx resource.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
37
|
+
* "Tags": [
|
|
38
|
+
* {
|
|
39
|
+
* "Key": "Name",
|
|
40
|
+
* "Value": "MyFileSystem"
|
|
41
|
+
* }
|
|
42
|
+
* ]
|
|
43
|
+
* };
|
|
44
|
+
* const command = new TagResourceCommand(input);
|
|
45
|
+
* await client.send(command);
|
|
46
|
+
* // example id: to-tag-a-fsx-resource-1481847318371
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
32
49
|
*/
|
|
33
50
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, FSxClientResolvedConfig> {
|
|
34
51
|
readonly input: TagResourceCommandInput;
|
|
@@ -29,6 +29,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
29
29
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To untag a resource
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // This operation untags an Amazon FSx resource.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
37
|
+
* "TagKeys": [
|
|
38
|
+
* "Name"
|
|
39
|
+
* ]
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UntagResourceCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: to-untag-a-fsx-resource-1481847318373
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
32
46
|
*/
|
|
33
47
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, FSxClientResolvedConfig> {
|
|
34
48
|
readonly input: UntagResourceCommandInput;
|
|
@@ -181,6 +181,52 @@ export interface UpdateFileSystemCommandOutput extends UpdateFileSystemResponse,
|
|
|
181
181
|
* @see {@link UpdateFileSystemCommandOutput} for command's `response` shape.
|
|
182
182
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
183
183
|
*
|
|
184
|
+
* @example To update an existing file system
|
|
185
|
+
* ```javascript
|
|
186
|
+
* // This operation updates an existing file system.
|
|
187
|
+
* const input = {
|
|
188
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
189
|
+
* "WindowsConfiguration": {
|
|
190
|
+
* "AutomaticBackupRetentionDays": 10,
|
|
191
|
+
* "DailyAutomaticBackupStartTime": "06:00",
|
|
192
|
+
* "WeeklyMaintenanceStartTime": "3:06:00"
|
|
193
|
+
* }
|
|
194
|
+
* };
|
|
195
|
+
* const command = new UpdateFileSystemCommand(input);
|
|
196
|
+
* const response = await client.send(command);
|
|
197
|
+
* /* response ==
|
|
198
|
+
* {
|
|
199
|
+
* "FileSystem": {
|
|
200
|
+
* "CreationTime": "1481841524.0",
|
|
201
|
+
* "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
|
202
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
203
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
|
204
|
+
* "Lifecycle": "AVAILABLE",
|
|
205
|
+
* "OwnerId": "012345678912",
|
|
206
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
207
|
+
* "StorageCapacity": 300,
|
|
208
|
+
* "SubnetIds": [
|
|
209
|
+
* "subnet-1234abcd"
|
|
210
|
+
* ],
|
|
211
|
+
* "Tags": [
|
|
212
|
+
* {
|
|
213
|
+
* "Key": "Name",
|
|
214
|
+
* "Value": "MyFileSystem"
|
|
215
|
+
* }
|
|
216
|
+
* ],
|
|
217
|
+
* "VpcId": "vpc-ab1234cd",
|
|
218
|
+
* "WindowsConfiguration": {
|
|
219
|
+
* "AutomaticBackupRetentionDays": 10,
|
|
220
|
+
* "DailyAutomaticBackupStartTime": "06:00",
|
|
221
|
+
* "ThroughputCapacity": 8,
|
|
222
|
+
* "WeeklyMaintenanceStartTime": "3:06:00"
|
|
223
|
+
* }
|
|
224
|
+
* }
|
|
225
|
+
* }
|
|
226
|
+
* *\/
|
|
227
|
+
* // example id: to-update-a-file-system-1481840798595
|
|
228
|
+
* ```
|
|
229
|
+
*
|
|
184
230
|
*/
|
|
185
231
|
export declare class UpdateFileSystemCommand extends $Command<UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput, FSxClientResolvedConfig> {
|
|
186
232
|
readonly input: UpdateFileSystemCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-fsx",
|
|
3
3
|
"description": "AWS SDK for JavaScript Fsx Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,37 +20,37 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
43
|
+
"@aws-sdk/types": "3.289.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
55
|
"tslib": "^2.3.1",
|
|
56
56
|
"uuid": "^8.3.2"
|