1{ 2 "version": "1.0", 3 "examples": { 4 "CreateFileSystem": [ 5 { 6 "input": { 7 "Backup": true, 8 "CreationToken": "tokenstring", 9 "Encrypted": true, 10 "PerformanceMode": "generalPurpose", 11 "Tags": [ 12 { 13 "Key": "Name", 14 "Value": "MyFileSystem" 15 } 16 ] 17 }, 18 "output": { 19 "CreationTime": "1481841524.0", 20 "CreationToken": "tokenstring", 21 "Encrypted": true, 22 "FileSystemId": "fs-01234567", 23 "LifeCycleState": "creating", 24 "NumberOfMountTargets": 0, 25 "OwnerId": "012345678912", 26 "PerformanceMode": "generalPurpose", 27 "SizeInBytes": { 28 "Value": 0 29 }, 30 "Tags": [ 31 { 32 "Key": "Name", 33 "Value": "MyFileSystem" 34 } 35 ] 36 }, 37 "comments": { 38 "input": { 39 }, 40 "output": { 41 } 42 }, 43 "description": "This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.", 44 "id": "to-create-a-new-file-system-1481840798547", 45 "title": "To create a new file system" 46 } 47 ], 48 "CreateMountTarget": [ 49 { 50 "input": { 51 "FileSystemId": "fs-01234567", 52 "SubnetId": "subnet-1234abcd" 53 }, 54 "output": { 55 "FileSystemId": "fs-01234567", 56 "IpAddress": "192.0.0.2", 57 "LifeCycleState": "creating", 58 "MountTargetId": "fsmt-12340abc", 59 "NetworkInterfaceId": "eni-cedf6789", 60 "OwnerId": "012345678912", 61 "SubnetId": "subnet-1234abcd" 62 }, 63 "comments": { 64 "input": { 65 }, 66 "output": { 67 } 68 }, 69 "description": "This operation creates a new mount target for an EFS file system.", 70 "id": "to-create-a-new-mount-target-1481842289329", 71 "title": "To create a new mount target" 72 } 73 ], 74 "CreateTags": [ 75 { 76 "input": { 77 "FileSystemId": "fs-01234567", 78 "Tags": [ 79 { 80 "Key": "Name", 81 "Value": "MyFileSystem" 82 } 83 ] 84 }, 85 "comments": { 86 }, 87 "description": "This operation creates a new tag for an EFS file system.", 88 "id": "to-create-a-new-tag-1481843409357", 89 "title": "To create a new tag" 90 } 91 ], 92 "DeleteFileSystem": [ 93 { 94 "input": { 95 "FileSystemId": "fs-01234567" 96 }, 97 "comments": { 98 }, 99 "description": "This operation deletes an EFS file system.", 100 "id": "to-delete-a-file-system-1481847318348", 101 "title": "To delete a file system" 102 } 103 ], 104 "DeleteMountTarget": [ 105 { 106 "input": { 107 "MountTargetId": "fsmt-12340abc" 108 }, 109 "comments": { 110 }, 111 "description": "This operation deletes a mount target.", 112 "id": "to-delete-a-mount-target-1481847635607", 113 "title": "To delete a mount target" 114 } 115 ], 116 "DeleteTags": [ 117 { 118 "input": { 119 "FileSystemId": "fs-01234567", 120 "TagKeys": [ 121 "Name" 122 ] 123 }, 124 "comments": { 125 }, 126 "description": "This operation deletes tags for an EFS file system.", 127 "id": "to-delete-tags-for-an-efs-file-system-1481848189061", 128 "title": "To delete tags for an EFS file system" 129 } 130 ], 131 "DescribeFileSystems": [ 132 { 133 "input": { 134 }, 135 "output": { 136 "FileSystems": [ 137 { 138 "CreationTime": "1481841524.0", 139 "CreationToken": "tokenstring", 140 "FileSystemId": "fs-01234567", 141 "LifeCycleState": "available", 142 "Name": "MyFileSystem", 143 "NumberOfMountTargets": 1, 144 "OwnerId": "012345678912", 145 "PerformanceMode": "generalPurpose", 146 "SizeInBytes": { 147 "Value": 6144 148 }, 149 "Tags": [ 150 { 151 "Key": "Name", 152 "Value": "MyFileSystem" 153 } 154 ] 155 } 156 ] 157 }, 158 "comments": { 159 }, 160 "description": "This operation describes all of the EFS file systems in an account.", 161 "id": "to-describe-an-efs-file-system-1481848448460", 162 "title": "To describe an EFS file system" 163 } 164 ], 165 "DescribeLifecycleConfiguration": [ 166 { 167 "input": { 168 "FileSystemId": "fs-01234567" 169 }, 170 "output": { 171 "LifecyclePolicies": [ 172 { 173 "TransitionToIA": "AFTER_30_DAYS" 174 } 175 ] 176 }, 177 "comments": { 178 "input": { 179 }, 180 "output": { 181 } 182 }, 183 "description": "This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. ", 184 "id": "to-describe-the-lifecycle-configuration-for-a-file-system-1551200664502", 185 "title": "To describe the lifecycle configuration for a file system" 186 } 187 ], 188 "DescribeMountTargetSecurityGroups": [ 189 { 190 "input": { 191 "MountTargetId": "fsmt-12340abc" 192 }, 193 "output": { 194 "SecurityGroups": [ 195 "sg-4567abcd" 196 ] 197 }, 198 "comments": { 199 }, 200 "description": "This operation describes all of the security groups for a file system's mount target.", 201 "id": "to-describe-the-security-groups-for-a-mount-target-1481849317823", 202 "title": "To describe the security groups for a mount target" 203 } 204 ], 205 "DescribeMountTargets": [ 206 { 207 "input": { 208 "FileSystemId": "fs-01234567" 209 }, 210 "output": { 211 "MountTargets": [ 212 { 213 "FileSystemId": "fs-01234567", 214 "IpAddress": "192.0.0.2", 215 "LifeCycleState": "available", 216 "MountTargetId": "fsmt-12340abc", 217 "NetworkInterfaceId": "eni-cedf6789", 218 "OwnerId": "012345678912", 219 "SubnetId": "subnet-1234abcd" 220 } 221 ] 222 }, 223 "comments": { 224 }, 225 "description": "This operation describes all of a file system's mount targets.", 226 "id": "to-describe-the-mount-targets-for-a-file-system-1481849958584", 227 "title": "To describe the mount targets for a file system" 228 } 229 ], 230 "DescribeTags": [ 231 { 232 "input": { 233 "FileSystemId": "fs-01234567" 234 }, 235 "output": { 236 "Tags": [ 237 { 238 "Key": "Name", 239 "Value": "MyFileSystem" 240 } 241 ] 242 }, 243 "comments": { 244 }, 245 "description": "This operation describes all of a file system's tags.", 246 "id": "to-describe-the-tags-for-a-file-system-1481850497090", 247 "title": "To describe the tags for a file system" 248 } 249 ], 250 "ModifyMountTargetSecurityGroups": [ 251 { 252 "input": { 253 "MountTargetId": "fsmt-12340abc", 254 "SecurityGroups": [ 255 "sg-abcd1234" 256 ] 257 }, 258 "comments": { 259 }, 260 "description": "This operation modifies the security groups associated with a mount target for a file system.", 261 "id": "to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562", 262 "title": "To modify the security groups associated with a mount target for a file system" 263 } 264 ], 265 "PutLifecycleConfiguration": [ 266 { 267 "input": { 268 "FileSystemId": "fs-01234567", 269 "LifecyclePolicies": [ 270 { 271 "TransitionToIA": "AFTER_30_DAYS" 272 } 273 ] 274 }, 275 "output": { 276 "LifecyclePolicies": [ 277 { 278 "TransitionToIA": "AFTER_30_DAYS" 279 } 280 ] 281 }, 282 "comments": { 283 "input": { 284 }, 285 "output": { 286 } 287 }, 288 "description": "This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.", 289 "id": "creates-a-new-lifecycleconfiguration-object-for-a-file-system-1551201594692", 290 "title": "Creates a new lifecycleconfiguration object for a file system" 291 } 292 ] 293 } 294} 295