Amazon Elastic File System

{'MountTargetId': 'string'}

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.

Request Syntax

client.describe_mount_targets(
    MaxItems=123,
    Marker='string',
    FileSystemId='string',
    MountTargetId='string'
)

type MaxItems:

integer

param MaxItems:

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

type Marker:

string

param Marker:

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.

type FileSystemId:

string

param FileSystemId:

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.

type MountTargetId:

string

param MountTargetId:

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.

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'MountTargets': [
        {
            'OwnerId': 'string',
            'MountTargetId': 'string',
            'FileSystemId': 'string',
            'SubnetId': 'string',
            'LifeCycleState': 'creating'|'available'|'deleting'|'deleted',
            'IpAddress': 'string',
            'NetworkInterfaceId': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  • Marker (string) --

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

  • MountTargets (list) --

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

    • (dict) --

      This object provides description of a mount target.

      • OwnerId (string) --

        The AWS account ID that owns the resource.

      • MountTargetId (string) --

        The system-assigned mount target ID.

      • FileSystemId (string) --

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

      • SubnetId (string) --

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

      • LifeCycleState (string) --

        The lifecycle state the mount target is in.

      • IpAddress (string) --

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

      • NetworkInterfaceId (string) --

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

  • NextMarker (string) --

    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.