github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/fsx/2018-03-01/examples-1.json (about)

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