fsx-2018-03-01.min.json
   1  {
   2    "version": "2.0",
   3    "metadata": {
   4      "apiVersion": "2018-03-01",
   5      "endpointPrefix": "fsx",
   6      "jsonVersion": "1.1",
   7      "protocol": "json",
   8      "serviceFullName": "Amazon FSx",
   9      "serviceId": "FSx",
  10      "signatureVersion": "v4",
  11      "signingName": "fsx",
  12      "targetPrefix": "AWSSimbaAPIService_v20180301",
  13      "uid": "fsx-2018-03-01"
  14    },
  15    "operations": {
  16      "AssociateFileSystemAliases": {
  17        "input": {
  18          "type": "structure",
  19          "required": [
  20            "FileSystemId",
  21            "Aliases"
  22          ],
  23          "members": {
  24            "ClientRequestToken": {
  25              "idempotencyToken": true
  26            },
  27            "FileSystemId": {},
  28            "Aliases": {
  29              "shape": "S4"
  30            }
  31          }
  32        },
  33        "output": {
  34          "type": "structure",
  35          "members": {
  36            "Aliases": {
  37              "shape": "S7"
  38            }
  39          }
  40        }
  41      },
  42      "CancelDataRepositoryTask": {
  43        "input": {
  44          "type": "structure",
  45          "required": [
  46            "TaskId"
  47          ],
  48          "members": {
  49            "TaskId": {}
  50          }
  51        },
  52        "output": {
  53          "type": "structure",
  54          "members": {
  55            "Lifecycle": {},
  56            "TaskId": {}
  57          }
  58        },
  59        "idempotent": true
  60      },
  61      "CopyBackup": {
  62        "input": {
  63          "type": "structure",
  64          "required": [
  65            "SourceBackupId"
  66          ],
  67          "members": {
  68            "ClientRequestToken": {
  69              "idempotencyToken": true
  70            },
  71            "SourceBackupId": {},
  72            "SourceRegion": {},
  73            "KmsKeyId": {},
  74            "CopyTags": {
  75              "type": "boolean"
  76            },
  77            "Tags": {
  78              "shape": "Sj"
  79            }
  80          }
  81        },
  82        "output": {
  83          "type": "structure",
  84          "members": {
  85            "Backup": {
  86              "shape": "So"
  87            }
  88          }
  89        },
  90        "idempotent": true
  91      },
  92      "CreateBackup": {
  93        "input": {
  94          "type": "structure",
  95          "required": [
  96            "FileSystemId"
  97          ],
  98          "members": {
  99            "FileSystemId": {},
 100            "ClientRequestToken": {
 101              "idempotencyToken": true
 102            },
 103            "Tags": {
 104              "shape": "Sj"
 105            }
 106          }
 107        },
 108        "output": {
 109          "type": "structure",
 110          "members": {
 111            "Backup": {
 112              "shape": "So"
 113            }
 114          }
 115        },
 116        "idempotent": true
 117      },
 118      "CreateDataRepositoryTask": {
 119        "input": {
 120          "type": "structure",
 121          "required": [
 122            "Type",
 123            "FileSystemId",
 124            "Report"
 125          ],
 126          "members": {
 127            "Type": {},
 128            "Paths": {
 129              "shape": "S2g"
 130            },
 131            "FileSystemId": {},
 132            "Report": {
 133              "shape": "S2i"
 134            },
 135            "ClientRequestToken": {
 136              "idempotencyToken": true
 137            },
 138            "Tags": {
 139              "shape": "Sj"
 140            }
 141          }
 142        },
 143        "output": {
 144          "type": "structure",
 145          "members": {
 146            "DataRepositoryTask": {
 147              "shape": "S2m"
 148            }
 149          }
 150        },
 151        "idempotent": true
 152      },
 153      "CreateFileSystem": {
 154        "input": {
 155          "type": "structure",
 156          "required": [
 157            "FileSystemType",
 158            "StorageCapacity",
 159            "SubnetIds"
 160          ],
 161          "members": {
 162            "ClientRequestToken": {
 163              "idempotencyToken": true
 164            },
 165            "FileSystemType": {},
 166            "StorageCapacity": {
 167              "type": "integer"
 168            },
 169            "StorageType": {},
 170            "SubnetIds": {
 171              "shape": "S15"
 172            },
 173            "SecurityGroupIds": {
 174              "shape": "S2w"
 175            },
 176            "Tags": {
 177              "shape": "Sj"
 178            },
 179            "KmsKeyId": {},
 180            "WindowsConfiguration": {
 181              "shape": "S2y"
 182            },
 183            "LustreConfiguration": {
 184              "shape": "S32"
 185            }
 186          }
 187        },
 188        "output": {
 189          "type": "structure",
 190          "members": {
 191            "FileSystem": {
 192              "shape": "Sx"
 193            }
 194          }
 195        }
 196      },
 197      "CreateFileSystemFromBackup": {
 198        "input": {
 199          "type": "structure",
 200          "required": [
 201            "BackupId",
 202            "SubnetIds"
 203          ],
 204          "members": {
 205            "BackupId": {},
 206            "ClientRequestToken": {
 207              "idempotencyToken": true
 208            },
 209            "SubnetIds": {
 210              "shape": "S15"
 211            },
 212            "SecurityGroupIds": {
 213              "shape": "S2w"
 214            },
 215            "Tags": {
 216              "shape": "Sj"
 217            },
 218            "WindowsConfiguration": {
 219              "shape": "S2y"
 220            },
 221            "LustreConfiguration": {
 222              "shape": "S32"
 223            },
 224            "StorageType": {},
 225            "KmsKeyId": {}
 226          }
 227        },
 228        "output": {
 229          "type": "structure",
 230          "members": {
 231            "FileSystem": {
 232              "shape": "Sx"
 233            }
 234          }
 235        }
 236      },
 237      "DeleteBackup": {
 238        "input": {
 239          "type": "structure",
 240          "required": [
 241            "BackupId"
 242          ],
 243          "members": {
 244            "BackupId": {},
 245            "ClientRequestToken": {
 246              "idempotencyToken": true
 247            }
 248          }
 249        },
 250        "output": {
 251          "type": "structure",
 252          "members": {
 253            "BackupId": {},
 254            "Lifecycle": {}
 255          }
 256        },
 257        "idempotent": true
 258      },
 259      "DeleteFileSystem": {
 260        "input": {
 261          "type": "structure",
 262          "required": [
 263            "FileSystemId"
 264          ],
 265          "members": {
 266            "FileSystemId": {},
 267            "ClientRequestToken": {
 268              "idempotencyToken": true
 269            },
 270            "WindowsConfiguration": {
 271              "type": "structure",
 272              "members": {
 273                "SkipFinalBackup": {
 274                  "type": "boolean"
 275                },
 276                "FinalBackupTags": {
 277                  "shape": "Sj"
 278                }
 279              }
 280            },
 281            "LustreConfiguration": {
 282              "type": "structure",
 283              "members": {
 284                "SkipFinalBackup": {
 285                  "type": "boolean"
 286                },
 287                "FinalBackupTags": {
 288                  "shape": "Sj"
 289                }
 290              }
 291            }
 292          }
 293        },
 294        "output": {
 295          "type": "structure",
 296          "members": {
 297            "FileSystemId": {},
 298            "Lifecycle": {},
 299            "WindowsResponse": {
 300              "type": "structure",
 301              "members": {
 302                "FinalBackupId": {},
 303                "FinalBackupTags": {
 304                  "shape": "Sj"
 305                }
 306              }
 307            },
 308            "LustreResponse": {
 309              "type": "structure",
 310              "members": {
 311                "FinalBackupId": {},
 312                "FinalBackupTags": {
 313                  "shape": "Sj"
 314                }
 315              }
 316            }
 317          }
 318        },
 319        "idempotent": true
 320      },
 321      "DescribeBackups": {
 322        "input": {
 323          "type": "structure",
 324          "members": {
 325            "BackupIds": {
 326              "type": "list",
 327              "member": {}
 328            },
 329            "Filters": {
 330              "type": "list",
 331              "member": {
 332                "type": "structure",
 333                "members": {
 334                  "Name": {},
 335                  "Values": {
 336                    "type": "list",
 337                    "member": {}
 338                  }
 339                }
 340              }
 341            },
 342            "MaxResults": {
 343              "type": "integer"
 344            },
 345            "NextToken": {}
 346          }
 347        },
 348        "output": {
 349          "type": "structure",
 350          "members": {
 351            "Backups": {
 352              "type": "list",
 353              "member": {
 354                "shape": "So"
 355              }
 356            },
 357            "NextToken": {}
 358          }
 359        }
 360      },
 361      "DescribeDataRepositoryTasks": {
 362        "input": {
 363          "type": "structure",
 364          "members": {
 365            "TaskIds": {
 366              "type": "list",
 367              "member": {}
 368            },
 369            "Filters": {
 370              "type": "list",
 371              "member": {
 372                "type": "structure",
 373                "members": {
 374                  "Name": {},
 375                  "Values": {
 376                    "type": "list",
 377                    "member": {}
 378                  }
 379                }
 380              }
 381            },
 382            "MaxResults": {
 383              "type": "integer"
 384            },
 385            "NextToken": {}
 386          }
 387        },
 388        "output": {
 389          "type": "structure",
 390          "members": {
 391            "DataRepositoryTasks": {
 392              "type": "list",
 393              "member": {
 394                "shape": "S2m"
 395              }
 396            },
 397            "NextToken": {}
 398          }
 399        }
 400      },
 401      "DescribeFileSystemAliases": {
 402        "input": {
 403          "type": "structure",
 404          "required": [
 405            "FileSystemId"
 406          ],
 407          "members": {
 408            "ClientRequestToken": {
 409              "idempotencyToken": true
 410            },
 411            "FileSystemId": {},
 412            "MaxResults": {
 413              "type": "integer"
 414            },
 415            "NextToken": {}
 416          }
 417        },
 418        "output": {
 419          "type": "structure",
 420          "members": {
 421            "Aliases": {
 422              "shape": "S7"
 423            },
 424            "NextToken": {}
 425          }
 426        }
 427      },
 428      "DescribeFileSystems": {
 429        "input": {
 430          "type": "structure",
 431          "members": {
 432            "FileSystemIds": {
 433              "type": "list",
 434              "member": {}
 435            },
 436            "MaxResults": {
 437              "type": "integer"
 438            },
 439            "NextToken": {}
 440          }
 441        },
 442        "output": {
 443          "type": "structure",
 444          "members": {
 445            "FileSystems": {
 446              "type": "list",
 447              "member": {
 448                "shape": "Sx"
 449              }
 450            },
 451            "NextToken": {}
 452          }
 453        }
 454      },
 455      "DisassociateFileSystemAliases": {
 456        "input": {
 457          "type": "structure",
 458          "required": [
 459            "FileSystemId",
 460            "Aliases"
 461          ],
 462          "members": {
 463            "ClientRequestToken": {
 464              "idempotencyToken": true
 465            },
 466            "FileSystemId": {},
 467            "Aliases": {
 468              "shape": "S4"
 469            }
 470          }
 471        },
 472        "output": {
 473          "type": "structure",
 474          "members": {
 475            "Aliases": {
 476              "shape": "S7"
 477            }
 478          }
 479        }
 480      },
 481      "ListTagsForResource": {
 482        "input": {
 483          "type": "structure",
 484          "required": [
 485            "ResourceARN"
 486          ],
 487          "members": {
 488            "ResourceARN": {},
 489            "MaxResults": {
 490              "type": "integer"
 491            },
 492            "NextToken": {}
 493          }
 494        },
 495        "output": {
 496          "type": "structure",
 497          "members": {
 498            "Tags": {
 499              "shape": "Sj"
 500            },
 501            "NextToken": {}
 502          }
 503        }
 504      },
 505      "TagResource": {
 506        "input": {
 507          "type": "structure",
 508          "required": [
 509            "ResourceARN",
 510            "Tags"
 511          ],
 512          "members": {
 513            "ResourceARN": {},
 514            "Tags": {
 515              "shape": "Sj"
 516            }
 517          }
 518        },
 519        "output": {
 520          "type": "structure",
 521          "members": {}
 522        },
 523        "idempotent": true
 524      },
 525      "UntagResource": {
 526        "input": {
 527          "type": "structure",
 528          "required": [
 529            "ResourceARN",
 530            "TagKeys"
 531          ],
 532          "members": {
 533            "ResourceARN": {},
 534            "TagKeys": {
 535              "type": "list",
 536              "member": {}
 537            }
 538          }
 539        },
 540        "output": {
 541          "type": "structure",
 542          "members": {}
 543        },
 544        "idempotent": true
 545      },
 546      "UpdateFileSystem": {
 547        "input": {
 548          "type": "structure",
 549          "required": [
 550            "FileSystemId"
 551          ],
 552          "members": {
 553            "FileSystemId": {},
 554            "ClientRequestToken": {
 555              "idempotencyToken": true
 556            },
 557            "StorageCapacity": {
 558              "type": "integer"
 559            },
 560            "WindowsConfiguration": {
 561              "type": "structure",
 562              "members": {
 563                "WeeklyMaintenanceStartTime": {},
 564                "DailyAutomaticBackupStartTime": {},
 565                "AutomaticBackupRetentionDays": {
 566                  "type": "integer"
 567                },
 568                "ThroughputCapacity": {
 569                  "type": "integer"
 570                },
 571                "SelfManagedActiveDirectoryConfiguration": {
 572                  "type": "structure",
 573                  "members": {
 574                    "UserName": {},
 575                    "Password": {
 576                      "shape": "S30"
 577                    },
 578                    "DnsIps": {
 579                      "shape": "S1h"
 580                    }
 581                  }
 582                },
 583                "AuditLogConfiguration": {
 584                  "shape": "S31"
 585                }
 586              }
 587            },
 588            "LustreConfiguration": {
 589              "type": "structure",
 590              "members": {
 591                "WeeklyMaintenanceStartTime": {},
 592                "DailyAutomaticBackupStartTime": {},
 593                "AutomaticBackupRetentionDays": {
 594                  "type": "integer"
 595                },
 596                "AutoImportPolicy": {},
 597                "DataCompressionType": {}
 598              }
 599            }
 600          }
 601        },
 602        "output": {
 603          "type": "structure",
 604          "members": {
 605            "FileSystem": {
 606              "shape": "Sx"
 607            }
 608          }
 609        }
 610      }
 611    },
 612    "shapes": {
 613      "S4": {
 614        "type": "list",
 615        "member": {}
 616      },
 617      "S7": {
 618        "type": "list",
 619        "member": {
 620          "type": "structure",
 621          "members": {
 622            "Name": {},
 623            "Lifecycle": {}
 624          }
 625        }
 626      },
 627      "Sj": {
 628        "type": "list",
 629        "member": {
 630          "type": "structure",
 631          "required": [
 632            "Key",
 633            "Value"
 634          ],
 635          "members": {
 636            "Key": {},
 637            "Value": {}
 638          }
 639        }
 640      },
 641      "So": {
 642        "type": "structure",
 643        "required": [
 644          "BackupId",
 645          "Lifecycle",
 646          "Type",
 647          "CreationTime",
 648          "FileSystem"
 649        ],
 650        "members": {
 651          "BackupId": {},
 652          "Lifecycle": {},
 653          "FailureDetails": {
 654            "type": "structure",
 655            "members": {
 656              "Message": {}
 657            }
 658          },
 659          "Type": {},
 660          "ProgressPercent": {
 661            "type": "integer"
 662          },
 663          "CreationTime": {
 664            "type": "timestamp"
 665          },
 666          "KmsKeyId": {},
 667          "ResourceARN": {},
 668          "Tags": {
 669            "shape": "Sj"
 670          },
 671          "FileSystem": {
 672            "shape": "Sx"
 673          },
 674          "DirectoryInformation": {
 675            "type": "structure",
 676            "members": {
 677              "DomainName": {},
 678              "ActiveDirectoryId": {},
 679              "ResourceARN": {}
 680            }
 681          },
 682          "OwnerId": {},
 683          "SourceBackupId": {},
 684          "SourceBackupRegion": {}
 685        }
 686      },
 687      "Sx": {
 688        "type": "structure",
 689        "members": {
 690          "OwnerId": {},
 691          "CreationTime": {
 692            "type": "timestamp"
 693          },
 694          "FileSystemId": {},
 695          "FileSystemType": {},
 696          "Lifecycle": {},
 697          "FailureDetails": {
 698            "type": "structure",
 699            "members": {
 700              "Message": {}
 701            }
 702          },
 703          "StorageCapacity": {
 704            "type": "integer"
 705          },
 706          "StorageType": {},
 707          "VpcId": {},
 708          "SubnetIds": {
 709            "shape": "S15"
 710          },
 711          "NetworkInterfaceIds": {
 712            "type": "list",
 713            "member": {}
 714          },
 715          "DNSName": {},
 716          "KmsKeyId": {},
 717          "ResourceARN": {},
 718          "Tags": {
 719            "shape": "Sj"
 720          },
 721          "WindowsConfiguration": {
 722            "type": "structure",
 723            "members": {
 724              "ActiveDirectoryId": {},
 725              "SelfManagedActiveDirectoryConfiguration": {
 726                "type": "structure",
 727                "members": {
 728                  "DomainName": {},
 729                  "OrganizationalUnitDistinguishedName": {},
 730                  "FileSystemAdministratorsGroup": {},
 731                  "UserName": {},
 732                  "DnsIps": {
 733                    "shape": "S1h"
 734                  }
 735                }
 736              },
 737              "DeploymentType": {},
 738              "RemoteAdministrationEndpoint": {},
 739              "PreferredSubnetId": {},
 740              "PreferredFileServerIp": {},
 741              "ThroughputCapacity": {
 742                "type": "integer"
 743              },
 744              "MaintenanceOperationsInProgress": {
 745                "type": "list",
 746                "member": {}
 747              },
 748              "WeeklyMaintenanceStartTime": {},
 749              "DailyAutomaticBackupStartTime": {},
 750              "AutomaticBackupRetentionDays": {
 751                "type": "integer"
 752              },
 753              "CopyTagsToBackups": {
 754                "type": "boolean"
 755              },
 756              "Aliases": {
 757                "shape": "S7"
 758              },
 759              "AuditLogConfiguration": {
 760                "type": "structure",
 761                "required": [
 762                  "FileAccessAuditLogLevel",
 763                  "FileShareAccessAuditLogLevel"
 764                ],
 765                "members": {
 766                  "FileAccessAuditLogLevel": {},
 767                  "FileShareAccessAuditLogLevel": {},
 768                  "AuditLogDestination": {}
 769                }
 770              }
 771            }
 772          },
 773          "LustreConfiguration": {
 774            "type": "structure",
 775            "members": {
 776              "WeeklyMaintenanceStartTime": {},
 777              "DataRepositoryConfiguration": {
 778                "type": "structure",
 779                "members": {
 780                  "Lifecycle": {},
 781                  "ImportPath": {},
 782                  "ExportPath": {},
 783                  "ImportedFileChunkSize": {
 784                    "type": "integer"
 785                  },
 786                  "AutoImportPolicy": {},
 787                  "FailureDetails": {
 788                    "type": "structure",
 789                    "members": {
 790                      "Message": {}
 791                    }
 792                  }
 793                }
 794              },
 795              "DeploymentType": {},
 796              "PerUnitStorageThroughput": {
 797                "type": "integer"
 798              },
 799              "MountName": {},
 800              "DailyAutomaticBackupStartTime": {},
 801              "AutomaticBackupRetentionDays": {
 802                "type": "integer"
 803              },
 804              "CopyTagsToBackups": {
 805                "type": "boolean"
 806              },
 807              "DriveCacheType": {},
 808              "DataCompressionType": {}
 809            }
 810          },
 811          "AdministrativeActions": {
 812            "type": "list",
 813            "member": {
 814              "type": "structure",
 815              "members": {
 816                "AdministrativeActionType": {},
 817                "ProgressPercent": {
 818                  "type": "integer"
 819                },
 820                "RequestTime": {
 821                  "type": "timestamp"
 822                },
 823                "Status": {},
 824                "TargetFileSystemValues": {
 825                  "shape": "Sx"
 826                },
 827                "FailureDetails": {
 828                  "type": "structure",
 829                  "members": {
 830                    "Message": {}
 831                  }
 832                }
 833              }
 834            }
 835          }
 836        }
 837      },
 838      "S15": {
 839        "type": "list",
 840        "member": {}
 841      },
 842      "S1h": {
 843        "type": "list",
 844        "member": {}
 845      },
 846      "S2g": {
 847        "type": "list",
 848        "member": {}
 849      },
 850      "S2i": {
 851        "type": "structure",
 852        "required": [
 853          "Enabled"
 854        ],
 855        "members": {
 856          "Enabled": {
 857            "type": "boolean"
 858          },
 859          "Path": {},
 860          "Format": {},
 861          "Scope": {}
 862        }
 863      },
 864      "S2m": {
 865        "type": "structure",
 866        "required": [
 867          "TaskId",
 868          "Lifecycle",
 869          "Type",
 870          "CreationTime",
 871          "FileSystemId"
 872        ],
 873        "members": {
 874          "TaskId": {},
 875          "Lifecycle": {},
 876          "Type": {},
 877          "CreationTime": {
 878            "type": "timestamp"
 879          },
 880          "StartTime": {
 881            "type": "timestamp"
 882          },
 883          "EndTime": {
 884            "type": "timestamp"
 885          },
 886          "ResourceARN": {},
 887          "Tags": {
 888            "shape": "Sj"
 889          },
 890          "FileSystemId": {},
 891          "Paths": {
 892            "shape": "S2g"
 893          },
 894          "FailureDetails": {
 895            "type": "structure",
 896            "members": {
 897              "Message": {}
 898            }
 899          },
 900          "Status": {
 901            "type": "structure",
 902            "members": {
 903              "TotalCount": {
 904                "type": "long"
 905              },
 906              "SucceededCount": {
 907                "type": "long"
 908              },
 909              "FailedCount": {
 910                "type": "long"
 911              },
 912              "LastUpdatedTime": {
 913                "type": "timestamp"
 914              }
 915            }
 916          },
 917          "Report": {
 918            "shape": "S2i"
 919          }
 920        }
 921      },
 922      "S2w": {
 923        "type": "list",
 924        "member": {}
 925      },
 926      "S2y": {
 927        "type": "structure",
 928        "required": [
 929          "ThroughputCapacity"
 930        ],
 931        "members": {
 932          "ActiveDirectoryId": {},
 933          "SelfManagedActiveDirectoryConfiguration": {
 934            "type": "structure",
 935            "required": [
 936              "DomainName",
 937              "UserName",
 938              "Password",
 939              "DnsIps"
 940            ],
 941            "members": {
 942              "DomainName": {},
 943              "OrganizationalUnitDistinguishedName": {},
 944              "FileSystemAdministratorsGroup": {},
 945              "UserName": {},
 946              "Password": {
 947                "shape": "S30"
 948              },
 949              "DnsIps": {
 950                "shape": "S1h"
 951              }
 952            }
 953          },
 954          "DeploymentType": {},
 955          "PreferredSubnetId": {},
 956          "ThroughputCapacity": {
 957            "type": "integer"
 958          },
 959          "WeeklyMaintenanceStartTime": {},
 960          "DailyAutomaticBackupStartTime": {},
 961          "AutomaticBackupRetentionDays": {
 962            "type": "integer"
 963          },
 964          "CopyTagsToBackups": {
 965            "type": "boolean"
 966          },
 967          "Aliases": {
 968            "shape": "S4"
 969          },
 970          "AuditLogConfiguration": {
 971            "shape": "S31"
 972          }
 973        }
 974      },
 975      "S30": {
 976        "type": "string",
 977        "sensitive": true
 978      },
 979      "S31": {
 980        "type": "structure",
 981        "required": [
 982          "FileAccessAuditLogLevel",
 983          "FileShareAccessAuditLogLevel"
 984        ],
 985        "members": {
 986          "FileAccessAuditLogLevel": {},
 987          "FileShareAccessAuditLogLevel": {},
 988          "AuditLogDestination": {}
 989        }
 990      },
 991      "S32": {
 992        "type": "structure",
 993        "members": {
 994          "WeeklyMaintenanceStartTime": {},
 995          "ImportPath": {},
 996          "ExportPath": {},
 997          "ImportedFileChunkSize": {
 998            "type": "integer"
 999          },
1000          "DeploymentType": {},
1001          "AutoImportPolicy": {},
1002          "PerUnitStorageThroughput": {
1003            "type": "integer"
1004          },
1005          "DailyAutomaticBackupStartTime": {},
1006          "AutomaticBackupRetentionDays": {
1007            "type": "integer"
1008          },
1009          "CopyTagsToBackups": {
1010            "type": "boolean"
1011          },
1012          "DriveCacheType": {},
1013          "DataCompressionType": {}
1014        }
1015      }
1016    }
1017  }