Menu
Amazon Elastic File System
User Guide

DescribeMountTargets

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 permissions 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.

Request Syntax

Copy
GET /2015-02-01/mount-targets?FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems&MountTargetId=MountTargetId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

FileSystemId

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

Marker

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

MaxItems

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

Valid Range: Minimum value of 1.

MountTargetId

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

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "Marker": "string", "MountTargets": [ { "FileSystemId": "string", "IpAddress": "string", "LifeCycleState": "string", "MountTargetId": "string", "NetworkInterfaceId": "string", "OwnerId": "string", "SubnetId": "string" } ], "NextMarker": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Marker

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

Type: String

MountTargets

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

Type: Array of MountTargetDescription objects

NextMarker

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.

Type: String

Errors

BadRequest

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

HTTP Status Code: 400

FileSystemNotFound

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

HTTP Status Code: 404

InternalServerError

Returned if an error occurred on the server side.

HTTP Status Code: 500

MountTargetNotFound

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

HTTP Status Code: 404

Example

Retrieve descriptions mount targets created for a file system

The following request retrieves descriptions of mount targets created for the specified file system.

Sample Request

Copy
GET /2015-02-01/mount-targets?FileSystemId=fs-47a2c22e HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140622T191252Z Authorization: <...>

Sample Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: ab5f2427-3ab3-4002-868e-30a77a88f739 Content-Type: application/json Content-Length: 357 { "MountTargets":[ { "OwnerId":"251839141158", "MountTargetId":"fsmt-9a13661e", "FileSystemId":"fs-47a2c22e", "SubnetId":"subnet-fd04ff94", "LifeCycleState":"added", "IpAddress":"10.0.2.42", "NetworkInterfaceId":"eni-1bcb7772" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: