S3Files / Paginator / ListMountTargets

ListMountTargets

class S3Files.Paginator.ListMountTargets
paginator = client.get_paginator('list_mount_targets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Files.Client.list_mount_targets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    fileSystemId='string',
    accessPointId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • fileSystemId (string) – Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.

  • accessPointId (string) – Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).

  • 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

{
    'mountTargets': [
        {
            'availabilityZoneId': 'string',
            'fileSystemId': 'string',
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
            'statusMessage': 'string',
            'mountTargetId': 'string',
            'networkInterfaceId': 'string',
            'ownerId': 'string',
            'subnetId': 'string',
            'vpcId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • mountTargets (list) –

      An array of mount target descriptions.

      • (dict) –

        Contains information about a mount target returned in list operations.

        • availabilityZoneId (string) –

          The Availability Zone ID where the mount target is located.

        • fileSystemId (string) –

          The ID of the S3 File System.

        • ipv4Address (string) –

          The IPv4 address of the mount target.

        • ipv6Address (string) –

          The IPv6 address of the mount target.

        • status (string) –

          The current status of the mount target.

        • statusMessage (string) –

          Additional information about the mount target status.

        • mountTargetId (string) –

          The ID of the mount target.

        • networkInterfaceId (string) –

          The ID of the network interface associated with the mount target.

        • ownerId (string) –

          The Amazon Web Services account ID of the mount target owner.

        • subnetId (string) –

          The ID of the subnet where the mount target is located.

        • vpcId (string) –

          The ID of the VPC where the mount target is located.

    • NextToken (string) –

      A token to resume pagination.