| 1 | {
|
| 2 | "version": "1.0",
|
| 3 | "examples": {
|
| 4 | "CreateBackup": [
|
| 5 | {
|
| 6 | "input": {
|
| 7 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 8 | "Tags": [
|
| 9 | {
|
| 10 | "Key": "Name",
|
| 11 | "Value": "MyBackup"
|
| 12 | }
|
| 13 | ]
|
| 14 | },
|
| 15 | "output": {
|
| 16 | "Backup": {
|
| 17 | "BackupId": "backup-03e3c82e0183b7b6b",
|
| 18 | "CreationTime": "1481841524.0",
|
| 19 | "FileSystem": {
|
| 20 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 21 | "OwnerId": "012345678912",
|
| 22 | "StorageCapacity": 300,
|
| 23 | "WindowsConfiguration": {
|
| 24 | "ActiveDirectoryId": "d-1234abcd12",
|
| 25 | "AutomaticBackupRetentionDays": 30,
|
| 26 | "DailyAutomaticBackupStartTime": "05:00",
|
| 27 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 28 | }
|
| 29 | },
|
| 30 | "Lifecycle": "CREATING",
|
| 31 | "ProgressPercent": 0,
|
| 32 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
|
| 33 | "Tags": [
|
| 34 | {
|
| 35 | "Key": "Name",
|
| 36 | "Value": "MyBackup"
|
| 37 | }
|
| 38 | ],
|
| 39 | "Type": "USER_INITIATED"
|
| 40 | }
|
| 41 | },
|
| 42 | "comments": {
|
| 43 | },
|
| 44 | "description": "This operation creates a new backup.",
|
| 45 | "id": "to-create-a-new-backup-1481840798597",
|
| 46 | "title": "To create a new backup"
|
| 47 | }
|
| 48 | ],
|
| 49 | "CreateFileSystem": [
|
| 50 | {
|
| 51 | "input": {
|
| 52 | "ClientRequestToken": "a8ca07e4-61ec-4399-99f4-19853801bcd5",
|
| 53 | "FileSystemType": "WINDOWS",
|
| 54 | "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
| 55 | "SecurityGroupIds": [
|
| 56 | "sg-edcd9784"
|
| 57 | ],
|
| 58 | "StorageCapacity": 300,
|
| 59 | "SubnetIds": [
|
| 60 | "subnet-1234abcd"
|
| 61 | ],
|
| 62 | "Tags": [
|
| 63 | {
|
| 64 | "Key": "Name",
|
| 65 | "Value": "MyFileSystem"
|
| 66 | }
|
| 67 | ],
|
| 68 | "WindowsConfiguration": {
|
| 69 | "ActiveDirectoryId": "d-1234abcd12",
|
| 70 | "AutomaticBackupRetentionDays": 30,
|
| 71 | "DailyAutomaticBackupStartTime": "05:00",
|
| 72 | "ThroughputCapacity": 8,
|
| 73 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 74 | }
|
| 75 | },
|
| 76 | "output": {
|
| 77 | "FileSystem": {
|
| 78 | "CreationTime": "1481841524.0",
|
| 79 | "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
| 80 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 81 | "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
| 82 | "Lifecycle": "CREATING",
|
| 83 | "OwnerId": "012345678912",
|
| 84 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 85 | "StorageCapacity": 300,
|
| 86 | "SubnetIds": [
|
| 87 | "subnet-1234abcd"
|
| 88 | ],
|
| 89 | "Tags": [
|
| 90 | {
|
| 91 | "Key": "Name",
|
| 92 | "Value": "MyFileSystem"
|
| 93 | }
|
| 94 | ],
|
| 95 | "VpcId": "vpc-ab1234cd",
|
| 96 | "WindowsConfiguration": {
|
| 97 | "ActiveDirectoryId": "d-1234abcd12",
|
| 98 | "AutomaticBackupRetentionDays": 30,
|
| 99 | "DailyAutomaticBackupStartTime": "05:00",
|
| 100 | "ThroughputCapacity": 8,
|
| 101 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 102 | }
|
| 103 | }
|
| 104 | },
|
| 105 | "comments": {
|
| 106 | },
|
| 107 | "description": "This operation creates a new file system.",
|
| 108 | "id": "to-create-a-new-file-system-1481840798547",
|
| 109 | "title": "To create a new file system"
|
| 110 | }
|
| 111 | ],
|
| 112 | "CreateFileSystemFromBackup": [
|
| 113 | {
|
| 114 | "input": {
|
| 115 | "BackupId": "backup-03e3c82e0183b7b6b",
|
| 116 | "ClientRequestToken": "f4c94ed7-238d-4c46-93db-48cd62ec33b7",
|
| 117 | "SecurityGroupIds": [
|
| 118 | "sg-edcd9784"
|
| 119 | ],
|
| 120 | "SubnetIds": [
|
| 121 | "subnet-1234abcd"
|
| 122 | ],
|
| 123 | "Tags": [
|
| 124 | {
|
| 125 | "Key": "Name",
|
| 126 | "Value": "MyFileSystem"
|
| 127 | }
|
| 128 | ],
|
| 129 | "WindowsConfiguration": {
|
| 130 | "ThroughputCapacity": 8
|
| 131 | }
|
| 132 | },
|
| 133 | "output": {
|
| 134 | "FileSystem": {
|
| 135 | "CreationTime": "1481841524.0",
|
| 136 | "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
| 137 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 138 | "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
| 139 | "Lifecycle": "CREATING",
|
| 140 | "OwnerId": "012345678912",
|
| 141 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 142 | "StorageCapacity": 300,
|
| 143 | "SubnetIds": [
|
| 144 | "subnet-1234abcd"
|
| 145 | ],
|
| 146 | "Tags": [
|
| 147 | {
|
| 148 | "Key": "Name",
|
| 149 | "Value": "MyFileSystem"
|
| 150 | }
|
| 151 | ],
|
| 152 | "VpcId": "vpc-ab1234cd",
|
| 153 | "WindowsConfiguration": {
|
| 154 | "ActiveDirectoryId": "d-1234abcd12",
|
| 155 | "AutomaticBackupRetentionDays": 30,
|
| 156 | "DailyAutomaticBackupStartTime": "05:00",
|
| 157 | "ThroughputCapacity": 8,
|
| 158 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 159 | }
|
| 160 | }
|
| 161 | },
|
| 162 | "comments": {
|
| 163 | },
|
| 164 | "description": "This operation creates a new file system from backup.",
|
| 165 | "id": "to-create-a-new-file-system-from-backup-1481840798598",
|
| 166 | "title": "To create a new file system from backup"
|
| 167 | }
|
| 168 | ],
|
| 169 | "DeleteBackup": [
|
| 170 | {
|
| 171 | "input": {
|
| 172 | "BackupId": "backup-03e3c82e0183b7b6b"
|
| 173 | },
|
| 174 | "output": {
|
| 175 | "BackupId": "backup-03e3c82e0183b7b6b",
|
| 176 | "Lifecycle": "DELETED"
|
| 177 | },
|
| 178 | "comments": {
|
| 179 | },
|
| 180 | "description": "This operation deletes an Amazon FSx file system backup.",
|
| 181 | "id": "to-delete-a-file-system-1481847318399",
|
| 182 | "title": "To delete a backup"
|
| 183 | }
|
| 184 | ],
|
| 185 | "DeleteFileSystem": [
|
| 186 | {
|
| 187 | "input": {
|
| 188 | "FileSystemId": "fs-0498eed5fe91001ec"
|
| 189 | },
|
| 190 | "output": {
|
| 191 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 192 | "Lifecycle": "DELETING"
|
| 193 | },
|
| 194 | "comments": {
|
| 195 | },
|
| 196 | "description": "This operation deletes an Amazon FSx file system.",
|
| 197 | "id": "to-delete-a-file-system-1481847318348",
|
| 198 | "title": "To delete a file system"
|
| 199 | }
|
| 200 | ],
|
| 201 | "DescribeBackups": [
|
| 202 | {
|
| 203 | "input": {
|
| 204 | },
|
| 205 | "output": {
|
| 206 | "Backups": [
|
| 207 | {
|
| 208 | "BackupId": "backup-03e3c82e0183b7b6b",
|
| 209 | "CreationTime": "1481841524.0",
|
| 210 | "FileSystem": {
|
| 211 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 212 | "OwnerId": "012345678912",
|
| 213 | "StorageCapacity": 300,
|
| 214 | "WindowsConfiguration": {
|
| 215 | "ActiveDirectoryId": "d-1234abcd12",
|
| 216 | "AutomaticBackupRetentionDays": 30,
|
| 217 | "DailyAutomaticBackupStartTime": "05:00",
|
| 218 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 219 | }
|
| 220 | },
|
| 221 | "Lifecycle": "AVAILABLE",
|
| 222 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
|
| 223 | "Tags": [
|
| 224 | {
|
| 225 | "Key": "Name",
|
| 226 | "Value": "MyBackup"
|
| 227 | }
|
| 228 | ],
|
| 229 | "Type": "USER_INITIATED"
|
| 230 | }
|
| 231 | ]
|
| 232 | },
|
| 233 | "comments": {
|
| 234 | },
|
| 235 | "description": "This operation describes all of the Amazon FSx backups in an account.",
|
| 236 | "id": "to-describe-backups-1481848448499",
|
| 237 | "title": "To describe Amazon FSx backups"
|
| 238 | }
|
| 239 | ],
|
| 240 | "DescribeFileSystems": [
|
| 241 | {
|
| 242 | "input": {
|
| 243 | },
|
| 244 | "output": {
|
| 245 | "FileSystems": [
|
| 246 | {
|
| 247 | "CreationTime": "1481841524.0",
|
| 248 | "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
| 249 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 250 | "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
| 251 | "Lifecycle": "AVAILABLE",
|
| 252 | "NetworkInterfaceIds": [
|
| 253 | "eni-abcd1234"
|
| 254 | ],
|
| 255 | "OwnerId": "012345678912",
|
| 256 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 257 | "StorageCapacity": 300,
|
| 258 | "SubnetIds": [
|
| 259 | "subnet-1234abcd"
|
| 260 | ],
|
| 261 | "Tags": [
|
| 262 | {
|
| 263 | "Key": "Name",
|
| 264 | "Value": "MyFileSystem"
|
| 265 | }
|
| 266 | ],
|
| 267 | "VpcId": "vpc-ab1234cd",
|
| 268 | "WindowsConfiguration": {
|
| 269 | "ActiveDirectoryId": "d-1234abcd12",
|
| 270 | "AutomaticBackupRetentionDays": 30,
|
| 271 | "DailyAutomaticBackupStartTime": "05:00",
|
| 272 | "ThroughputCapacity": 8,
|
| 273 | "WeeklyMaintenanceStartTime": "1:05:00"
|
| 274 | }
|
| 275 | }
|
| 276 | ]
|
| 277 | },
|
| 278 | "comments": {
|
| 279 | },
|
| 280 | "description": "This operation describes all of the Amazon FSx file systems in an account.",
|
| 281 | "id": "to-describe-a-file-systems-1481848448460",
|
| 282 | "title": "To describe an Amazon FSx file system"
|
| 283 | }
|
| 284 | ],
|
| 285 | "ListTagsForResource": [
|
| 286 | {
|
| 287 | "input": {
|
| 288 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"
|
| 289 | },
|
| 290 | "output": {
|
| 291 | "Tags": [
|
| 292 | {
|
| 293 | "Key": "Name",
|
| 294 | "Value": "MyFileSystem"
|
| 295 | }
|
| 296 | ]
|
| 297 | },
|
| 298 | "comments": {
|
| 299 | },
|
| 300 | "description": "This operation lists tags for an Amazon FSx resource.",
|
| 301 | "id": "to-list-tags-for-a-fsx-resource-1481847318372",
|
| 302 | "title": "To list tags for a resource"
|
| 303 | }
|
| 304 | ],
|
| 305 | "TagResource": [
|
| 306 | {
|
| 307 | "input": {
|
| 308 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 309 | "Tags": [
|
| 310 | {
|
| 311 | "Key": "Name",
|
| 312 | "Value": "MyFileSystem"
|
| 313 | }
|
| 314 | ]
|
| 315 | },
|
| 316 | "comments": {
|
| 317 | },
|
| 318 | "description": "This operation tags an Amazon FSx resource.",
|
| 319 | "id": "to-tag-a-fsx-resource-1481847318371",
|
| 320 | "title": "To tag a resource"
|
| 321 | }
|
| 322 | ],
|
| 323 | "UntagResource": [
|
| 324 | {
|
| 325 | "input": {
|
| 326 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 327 | "TagKeys": [
|
| 328 | "Name"
|
| 329 | ]
|
| 330 | },
|
| 331 | "comments": {
|
| 332 | },
|
| 333 | "description": "This operation untags an Amazon FSx resource.",
|
| 334 | "id": "to-untag-a-fsx-resource-1481847318373",
|
| 335 | "title": "To untag a resource"
|
| 336 | }
|
| 337 | ],
|
| 338 | "UpdateFileSystem": [
|
| 339 | {
|
| 340 | "input": {
|
| 341 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 342 | "WindowsConfiguration": {
|
| 343 | "AutomaticBackupRetentionDays": 10,
|
| 344 | "DailyAutomaticBackupStartTime": "06:00",
|
| 345 | "WeeklyMaintenanceStartTime": "3:06:00"
|
| 346 | }
|
| 347 | },
|
| 348 | "output": {
|
| 349 | "FileSystem": {
|
| 350 | "CreationTime": "1481841524.0",
|
| 351 | "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
| 352 | "FileSystemId": "fs-0498eed5fe91001ec",
|
| 353 | "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
| 354 | "Lifecycle": "AVAILABLE",
|
| 355 | "OwnerId": "012345678912",
|
| 356 | "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
| 357 | "StorageCapacity": 300,
|
| 358 | "SubnetIds": [
|
| 359 | "subnet-1234abcd"
|
| 360 | ],
|
| 361 | "Tags": [
|
| 362 | {
|
| 363 | "Key": "Name",
|
| 364 | "Value": "MyFileSystem"
|
| 365 | }
|
| 366 | ],
|
| 367 | "VpcId": "vpc-ab1234cd",
|
| 368 | "WindowsConfiguration": {
|
| 369 | "AutomaticBackupRetentionDays": 10,
|
| 370 | "DailyAutomaticBackupStartTime": "06:00",
|
| 371 | "ThroughputCapacity": 8,
|
| 372 | "WeeklyMaintenanceStartTime": "3:06:00"
|
| 373 | }
|
| 374 | }
|
| 375 | },
|
| 376 | "comments": {
|
| 377 | },
|
| 378 | "description": "This operation updates an existing file system.",
|
| 379 | "id": "to-update-a-file-system-1481840798595",
|
| 380 | "title": "To update an existing file system"
|
| 381 | }
|
| 382 | ]
|
| 383 | }
|
| 384 | }
|