{ "version":"2.0", "metadata":{ "apiVersion":"2015-02-01", "endpointPrefix":"elasticfilesystem", "serviceAbbreviation":"EFS", "serviceFullName":"Amazon Elastic File System", "signatureVersion":"v4", "protocol":"rest-json" }, "documentation":"Amazon Elastic File System", "operations":{ "CreateFileSystem":{ "name":"CreateFileSystem", "http":{ "method":"POST", "requestUri":"/2015-02-01/file-systems", "responseCode":201 }, "input":{"shape":"CreateFileSystemRequest"}, "output":{ "shape":"FileSystemDescription", "documentation":"

This object provides description of a file system.

" }, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the file system you are trying to create already exists, with the creation token you provided.

" }, { "shape":"FileSystemLimitExceeded", "error":{"httpStatusCode":403}, "exception":true, "documentation":"

Returned if the AWS account has already created maximum number of file systems allowed per account.

" } ], "documentation":"

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still \"creating\". You can check the file system creation status by calling the DescribeFileSystems API, which among other things returns the file system state.

After the file system is fully created, Amazon EFS sets its lifecycle state to \"available\", at which point you can create one or more mount targets for the file system (CreateMountTarget) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works

This operation requires permission for the elasticfilesystem:CreateFileSystem action.

" }, "CreateMountTarget":{ "name":"CreateMountTarget", "http":{ "method":"POST", "requestUri":"/2015-02-01/mount-targets", "responseCode":200 }, "input":{"shape":"CreateMountTargetRequest"}, "output":{ "shape":"MountTargetDescription", "documentation":"

This object provides description of a mount target.

" }, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" }, { "shape":"IncorrectFileSystemLifeCycleState", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the file system's life cycle state is not \"created\".

" }, { "shape":"MountTargetConflict", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

" }, { "shape":"SubnetNotFound", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if there is no subnet with ID SubnetId provided in the request.

" }, { "shape":"NoFreeAddressesInSubnet", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

" }, { "shape":"IpAddressInUse", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the request specified an IpAddress that is already in use in the subnet.

" }, { "shape":"NetworkInterfaceLimitExceeded", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, go to Amazon VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table).

" }, { "shape":"SecurityGroupLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the size of SecurityGroups specified in the request is greater than five.

" }, { "shape":"SecurityGroupNotFound", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if one of the specified security groups does not exist in the subnet's VPC.

" }, { "shape":"UnsupportedAvailabilityZone", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be \"available\" (see DescribeFileSystems).

In the request, you also provide a subnet ID, which serves several purposes:

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements:

If the request satisfies the requirements, Amazon EFS does the following:

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still \"creating\". You can check the mount target creation status by calling the DescribeFileSystems API, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permission for the following action on the file system:

This operation also requires permission for the following Amazon EC2 actions:

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/2015-02-01/create-tags/{FileSystemId}", "responseCode":204 }, "input":{"shape":"CreateTagsRequest"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" } ], "documentation":"

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the \"Name\" tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems API.

This operation requires permission for the elasticfilesystem:CreateTags action.

" }, "DeleteFileSystem":{ "name":"DeleteFileSystem", "http":{ "method":"DELETE", "requestUri":"/2015-02-01/file-systems/{FileSystemId}", "responseCode":204 }, "input":{"shape":"DeleteFileSystemRequest"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" }, { "shape":"FileSystemInUse", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if a file system has mount targets.

" } ], "documentation":"

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system.

You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still \"deleting\". You can check the file system deletion status by calling the DescribeFileSystems API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems will return a 404 \"FileSystemNotFound\" error.

This operation requires permission for the elasticfilesystem:DeleteFileSystem action.

" }, "DeleteMountTarget":{ "name":"DeleteMountTarget", "http":{ "method":"DELETE", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}", "responseCode":204 }, "input":{"shape":"DeleteMountTargetRequest"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"DependencyTimeout", "error":{"httpStatusCode":504}, "exception":true, "documentation":"

The service timed out trying to fulfill the request, and the client should try the call again.

" }, { "shape":"MountTargetNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

" } ], "documentation":"

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target.

This operation requires permission for the following action on the file system:

The DeleteMountTarget call returns while the mount target state is still \"deleting\". You can check the mount target deletion by calling the DescribeMountTargets API, which returns a list of mount target descriptions for the given file system.

The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/2015-02-01/delete-tags/{FileSystemId}", "responseCode":204 }, "input":{"shape":"DeleteTagsRequest"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" } ], "documentation":"

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to Tag Restrictions in the AWS Billing and Cost Management User Guide.

This operation requires permission for the elasticfilesystem:DeleteTags action.

" }, "DescribeFileSystems":{ "name":"DescribeFileSystems", "http":{ "method":"GET", "requestUri":"/2015-02-01/file-systems", "responseCode":200 }, "input":{"shape":"DescribeFileSystemsRequest"}, "output":{"shape":"DescribeFileSystemsResponse"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" } ], "documentation":"

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling DescribeFileSystems without the Marker and then continuing to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

Note that the implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified.

This operation requires permission for the elasticfilesystem:DescribeFileSystems action.

" }, "DescribeMountTargetSecurityGroups":{ "name":"DescribeMountTargetSecurityGroups", "http":{ "method":"GET", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", "responseCode":200 }, "input":{"shape":"DescribeMountTargetSecurityGroupsRequest"}, "output":{"shape":"DescribeMountTargetSecurityGroupsResponse"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"MountTargetNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

" }, { "shape":"IncorrectMountTargetState", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the mount target is not in the correct state for the operation.

" } ], "documentation":"

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not \"deleted\".

This operation requires permissions for the following actions:

" }, "DescribeMountTargets":{ "name":"DescribeMountTargets", "http":{ "method":"GET", "requestUri":"/2015-02-01/mount-targets", "responseCode":200 }, "input":{"shape":"DescribeMountTargetsRequest"}, "output":{"shape":"DescribeMountTargetsResponse"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" }, { "shape":"MountTargetNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

" } ], "documentation":"

Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

This operation requires permission for the elasticfilesystem:DescribeMountTargets action, on either the file system id that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"GET", "requestUri":"/2015-02-01/tags/{FileSystemId}/", "responseCode":200 }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResponse"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"FileSystemNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" } ], "documentation":"

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified.

This operation requires permission for the elasticfilesystem:DescribeTags action.

" }, "ModifyMountTargetSecurityGroups":{ "name":"ModifyMountTargetSecurityGroups", "http":{ "method":"PUT", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", "responseCode":204 }, "input":{"shape":"ModifyMountTargetSecurityGroupsRequest"}, "errors":[ { "shape":"BadRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, { "shape":"InternalServerError", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, { "shape":"MountTargetNotFound", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

" }, { "shape":"IncorrectMountTargetState", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the mount target is not in the correct state for the operation.

" }, { "shape":"SecurityGroupLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the size of SecurityGroups specified in the request is greater than five.

" }, { "shape":"SecurityGroupNotFound", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if one of the specified security groups does not exist in the subnet's VPC.

" } ], "documentation":"

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface (see CreateMountTarget). This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not \"deleted\".

The operation requires permissions for the following actions:

" } }, "shapes":{ "AwsAccountId":{"type":"string"}, "BadRequest":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

" }, "CreateFileSystemRequest":{ "type":"structure", "required":["CreationToken"], "members":{ "CreationToken":{ "shape":"CreationToken", "documentation":"

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

" } } }, "CreateMountTargetRequest":{ "type":"structure", "required":[ "FileSystemId", "SubnetId" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"

The ID of the file system for which to create the mount target.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The ID of the subnet to add the mount target in.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

A valid IPv4 address within the address range of the specified subnet.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

Up to 5 VPC security group IDs, of the form \"sg-xxxxxxxx\". These must be for the same VPC as subnet specified.

" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "FileSystemId", "Tags" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "location":"uri", "locationName":"FileSystemId", "documentation":"

String. The ID of the file system whose tags you want to modify. This operation modifies only the tags and not the file system.

" }, "Tags":{ "shape":"Tags", "documentation":"

An array of Tag objects to add. Each Tag object is a key-value pair.

" } } }, "CreationToken":{ "type":"string", "min":1, "max":64 }, "DeleteFileSystemRequest":{ "type":"structure", "required":["FileSystemId"], "members":{ "FileSystemId":{ "shape":"FileSystemId", "location":"uri", "locationName":"FileSystemId", "documentation":"

The ID of the file system you want to delete.

" } } }, "DeleteMountTargetRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "location":"uri", "locationName":"MountTargetId", "documentation":"

String. The ID of the mount target to delete.

" } } }, "DeleteTagsRequest":{ "type":"structure", "required":[ "FileSystemId", "TagKeys" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "location":"uri", "locationName":"FileSystemId", "documentation":"

String. The ID of the file system whose tags you want to delete.

" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

A list of tag keys to delete.

" } } }, "DependencyTimeout":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":504}, "exception":true, "documentation":"

The service timed out trying to fulfill the request, and the client should try the call again.

" }, "DescribeFileSystemsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "location":"querystring", "locationName":"MaxItems", "documentation":"

Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

" }, "Marker":{ "shape":"Marker", "location":"querystring", "locationName":"Marker", "documentation":"

Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.

" }, "CreationToken":{ "shape":"CreationToken", "location":"querystring", "locationName":"CreationToken", "documentation":"

Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).

" }, "FileSystemId":{ "shape":"FileSystemId", "location":"querystring", "locationName":"FileSystemId", "documentation":"

Optional string. File system ID whose description you want to retrieve.

" } } }, "DescribeFileSystemsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

A string, present if provided by caller in the request.

" }, "FileSystems":{ "shape":"FileSystemDescriptions", "documentation":"

An array of file system descriptions.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

A string, present if there are more file systems than returned in the response. You can use the NextMarker in the subsequent request to fetch the descriptions.

" } } }, "DescribeMountTargetSecurityGroupsRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "location":"uri", "locationName":"MountTargetId", "documentation":"

The ID of the mount target whose security groups you want to retrieve.

" } } }, "DescribeMountTargetSecurityGroupsResponse":{ "type":"structure", "required":["SecurityGroups"], "members":{ "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

An array of security groups.

" } } }, "DescribeMountTargetsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "location":"querystring", "locationName":"MaxItems", "documentation":"

Optional. Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.

" }, "Marker":{ "shape":"Marker", "location":"querystring", "locationName":"Marker", "documentation":"

Optional. String. Opaque pagination token returned from a previous DescribeMountTargets operation. If present, it specifies to continue the list from where the previous returning call left off.

" }, "FileSystemId":{ "shape":"FileSystemId", "location":"querystring", "locationName":"FileSystemId", "documentation":"

Optional. String. The ID of the file system whose mount targets you want to list. It must be included in your request if MountTargetId is not included.

" }, "MountTargetId":{ "shape":"MountTargetId", "location":"querystring", "locationName":"MountTargetId", "documentation":"

Optional. String. The ID of the mount target that you want to have described. It must be included in your request if FileSystemId is not included.

" } } }, "DescribeMountTargetsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

If the request included the Marker, the response returns that value in this field.

" }, "MountTargets":{ "shape":"MountTargetDescriptions", "documentation":"

Returns the file system's mount targets as an array of MountTargetDescription objects.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets.

" } } }, "DescribeTagsRequest":{ "type":"structure", "required":["FileSystemId"], "members":{ "MaxItems":{ "shape":"MaxItems", "location":"querystring", "locationName":"MaxItems", "documentation":"

Optional. Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.

" }, "Marker":{ "shape":"Marker", "location":"querystring", "locationName":"Marker", "documentation":"

Optional. String. Opaque pagination token returned from a previous DescribeTags operation. If present, it specifies to continue the list from where the previous call left off.

" }, "FileSystemId":{ "shape":"FileSystemId", "location":"uri", "locationName":"FileSystemId", "documentation":"

The ID of the file system whose tag set you want to retrieve.

" } } }, "DescribeTagsResponse":{ "type":"structure", "required":["Tags"], "members":{ "Marker":{ "shape":"Marker", "documentation":"

If the request included a Marker, the response returns that value in this field.

" }, "Tags":{ "shape":"Tags", "documentation":"

Returns tags associated with the file system as an array of Tag objects.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.

" } } }, "ErrorCode":{ "type":"string", "min":1 }, "ErrorMessage":{"type":"string"}, "FileSystemAlreadyExists":{ "type":"structure", "required":[ "ErrorCode", "FileSystemId" ], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"}, "FileSystemId":{"shape":"FileSystemId"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the file system you are trying to create already exists, with the creation token you provided.

" }, "FileSystemDescription":{ "type":"structure", "required":[ "OwnerId", "CreationToken", "FileSystemId", "CreationTime", "LifeCycleState", "NumberOfMountTargets", "SizeInBytes" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"

The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

" }, "CreationToken":{ "shape":"CreationToken", "documentation":"

Opaque string specified in the request.

" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

The file system ID assigned by Amazon EFS.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"

A predefined string value that indicates the lifecycle phase of the file system.

" }, "Name":{ "shape":"TagValue", "documentation":"

You can add tags to a file system (see CreateTags) including a \"Name\" tag. If the file system has a \"Name\" tag, Amazon EFS returns the value in this field.

" }, "NumberOfMountTargets":{ "shape":"MountTargetCount", "documentation":"

The current number of mount targets (see CreateMountTarget) the file system has.

" }, "SizeInBytes":{ "shape":"FileSystemSize", "documentation":"

This object provides the latest known metered size of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.

" } }, "documentation":"

This object provides description of a file system.

" }, "FileSystemDescriptions":{ "type":"list", "member":{"shape":"FileSystemDescription"} }, "FileSystemId":{"type":"string"}, "FileSystemInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if a file system has mount targets.

" }, "FileSystemLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"

Returned if the AWS account has already created maximum number of file systems allowed per account.

" }, "FileSystemNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

" }, "FileSystemSize":{ "type":"structure", "required":["Value"], "members":{ "Value":{ "shape":"FileSystemSizeValue", "documentation":"

The latest known metered size, in bytes, of data stored in the file system.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.

" } }, "documentation":"

This object provides the latest known metered size, in bytes, of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

" }, "FileSystemSizeValue":{ "type":"long", "min":0 }, "IncorrectFileSystemLifeCycleState":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the file system's life cycle state is not \"created\".

" }, "IncorrectMountTargetState":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the mount target is not in the correct state for the operation.

" }, "InternalServerError":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":500}, "exception":true, "documentation":"

Returned if an error occurred on the server side.

" }, "IpAddress":{"type":"string"}, "IpAddressInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the request specified an IpAddress that is already in use in the subnet.

" }, "LifeCycleState":{ "type":"string", "enum":[ "creating", "available", "deleting", "deleted" ] }, "Marker":{"type":"string"}, "MaxItems":{ "type":"integer", "min":1 }, "ModifyMountTargetSecurityGroupsRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "location":"uri", "locationName":"MountTargetId", "documentation":"

The ID of the mount target whose security groups you want to modify.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

An array of up to five VPC security group IDs.

" } } }, "MountTargetConflict":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

" }, "MountTargetCount":{ "type":"integer", "min":0 }, "MountTargetDescription":{ "type":"structure", "required":[ "MountTargetId", "FileSystemId", "SubnetId", "LifeCycleState" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"

The AWS account ID that owns the resource.

" }, "MountTargetId":{ "shape":"MountTargetId", "documentation":"

The system-assigned mount target ID.

" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

The ID of the file system for which the mount target is intended.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The ID of the subnet that the mount target is in.

" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"

The lifecycle state the mount target is in.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

The address at which the file system may be mounted via the mount target.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

The ID of the network interface that Amazon EFS created when it created the mount target.

" } }, "documentation":"

This object provides description of a mount target.

" }, "MountTargetDescriptions":{ "type":"list", "member":{"shape":"MountTargetDescription"} }, "MountTargetId":{"type":"string"}, "MountTargetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

" }, "NetworkInterfaceId":{"type":"string"}, "NetworkInterfaceLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, go to Amazon VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table).

" }, "NoFreeAddressesInSubnet":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

" }, "SecurityGroup":{"type":"string"}, "SecurityGroupLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if the size of SecurityGroups specified in the request is greater than five.

" }, "SecurityGroupNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if one of the specified security groups does not exist in the subnet's VPC.

" }, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroup"}, "max":5 }, "SubnetId":{"type":"string"}, "SubnetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

Returned if there is no subnet with ID SubnetId provided in the request.

" }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Tag key, a string. The key must not start with \"aws:\".

" }, "Value":{ "shape":"TagValue", "documentation":"

Value of the tag key.

" } }, "documentation":"

A tag is a pair of key and value. The allowed characters in keys and values are letters, whitespace, and numbers, representable in UTF-8, and the characters '+', '-', '=', '.', '_', ':', and '/'.

" }, "TagKey":{ "type":"string", "min":1, "max":128 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagValue":{ "type":"string", "max":256 }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "Timestamp":{"type":"timestamp"}, "UnsupportedAvailabilityZone":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true } }, "examples":{ } }