EFS / Paginator / DescribeMountTargets

DescribeMountTargets

class EFS.Paginator.DescribeMountTargets

paginator = client.get_paginator('describe_mount_targets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EFS.Client.describe_mount_targets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FileSystemId='string',
    MountTargetId='string',
    AccessPointId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FileSystemId (string) – (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.

• MountTargetId (string) – (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. Accepts either a mount target ID or ARN as input.

• AccessPointId (string) – (Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'MountTargets': [
        {
            'OwnerId': 'string',
            'MountTargetId': 'string',
            'FileSystemId': 'string',
            'SubnetId': 'string',
            'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
            'IpAddress': 'string',
            'NetworkInterfaceId': 'string',
            'AvailabilityZoneId': 'string',
            'AvailabilityZoneName': 'string',
            'VpcId': 'string'
        },
    ],
    'NextToken': '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) –

      Provides a description of a mount target.

      • OwnerId (string) –

        Amazon Web Services account ID that owns the resource.

      • MountTargetId (string) –

        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 mount target’s subnet.

      • LifeCycleState (string) –

        Lifecycle state of the mount target.

      • IpAddress (string) –

        Address at which the file system can be mounted by using the mount target.

      • NetworkInterfaceId (string) –

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

      • AvailabilityZoneId (string) –

        The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.

      • AvailabilityZoneName (string) –

        The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.

      • VpcId (string) –

        The virtual private cloud (VPC) ID that the mount target is configured in.

  • NextToken (string) –

    A token to resume pagination.