S3Files / Client / list_mount_targets

list_mount_targets

S3Files.Client.list_mount_targets(**kwargs)

Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

See also: AWS API Documentation

Request Syntax

response = client.list_mount_targets(
    fileSystemId='string',
    accessPointId='string',
    maxResults=123,
    nextToken='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).

  • maxResults (integer) – The maximum number of mount targets to return in a single response.

  • nextToken (string) – A pagination token returned from a previous call to continue listing mount targets.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token to use in a subsequent request if more results are available.

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

Exceptions

  • S3Files.Client.exceptions.InternalServerException

  • S3Files.Client.exceptions.ResourceNotFoundException

  • S3Files.Client.exceptions.ThrottlingException

  • S3Files.Client.exceptions.ValidationException