Module Values.FileSystemDescriptionSource

A description of the file system.

Sourcetype nonrec t = {
  1. ownerId : AwsAccountId.t option;
    (*

    The Amazon Web Services account that created the file system.

    *)
  2. creationToken : CreationToken.t option;
    (*

    The opaque string specified in the request.

    *)
  3. fileSystemId : FileSystemId.t option;
    (*

    The ID of the file system, assigned by Amazon EFS.

    *)
  4. fileSystemArn : FileSystemArn.t option;
    (*

    The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

    *)
  5. creationTime : Timestamp.t option;
    (*

    The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

    *)
  6. lifeCycleState : LifeCycleState.t option;
    (*

    The lifecycle phase of the file system.

    *)
  7. name : TagValue.t option;
    (*

    You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.

    *)
  8. numberOfMountTargets : MountTargetCount.t option;
    (*

    The current number of mount targets that the file system has. For more information, see CreateMountTarget.

    *)
  9. sizeInBytes : FileSystemSize.t option;
    (*

    The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

    *)
  10. performanceMode : PerformanceMode.t option;
    (*

    The performance mode of the file system.

    *)
  11. encrypted : Encrypted.t option;
    (*

    A Boolean value that, if true, indicates that the file system is encrypted.

    *)
  12. kmsKeyId : KmsKeyId.t option;
    (*

    The ID of an KMS key used to protect the encrypted file system.

    *)
  13. throughputMode : ThroughputMode.t option;
    (*

    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

    *)
  14. provisionedThroughputInMibps : ProvisionedThroughputInMibps.t option;
    (*

    The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.

    *)
  15. availabilityZoneName : AvailabilityZoneName.t option;
    (*

    Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

    *)
  16. availabilityZoneId : AvailabilityZoneId.t option;
    (*

    The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

    *)
  17. tags : Tags.t option;
    (*

    The tags associated with the file system, presented as an array of Tag objects.

    *)
  18. fileSystemProtection : FileSystemProtectionDescription.t option;
    (*

    Describes the protection on the file system.

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequest of BadRequest.t
  2. | `FileSystemAlreadyExists of FileSystemAlreadyExists.t
  3. | `FileSystemLimitExceeded of FileSystemLimitExceeded.t
  4. | `InsufficientThroughputCapacity of InsufficientThroughputCapacity.t
  5. | `InternalServerError of InternalServerError.t
  6. | `ThroughputLimitExceeded of ThroughputLimitExceeded.t
  7. | `UnsupportedAvailabilityZone of UnsupportedAvailabilityZone.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?ownerId:??? -> ?creationToken:??? -> ?fileSystemId:??? -> ?fileSystemArn:??? -> ?creationTime:??? -> ?lifeCycleState:??? -> ?name:??? -> ?numberOfMountTargets:??? -> ?sizeInBytes:??? -> ?performanceMode:??? -> ?encrypted:??? -> ?kmsKeyId:??? -> ?throughputMode:??? -> ?provisionedThroughputInMibps:??? -> ?availabilityZoneName:??? -> ?availabilityZoneId:??? -> ?tags:??? -> ?fileSystemProtection:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequest of BadRequest.t | `FileSystemAlreadyExists of FileSystemAlreadyExists.t | `FileSystemLimitExceeded of FileSystemLimitExceeded.t | `InsufficientThroughputCapacity of InsufficientThroughputCapacity.t | `InternalServerError of InternalServerError.t | `ThroughputLimitExceeded of ThroughputLimitExceeded.t | `Unknown_operation_error of string * string option | `UnsupportedAvailabilityZone of UnsupportedAvailabilityZone.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequest of BadRequest.t | `FileSystemAlreadyExists of FileSystemAlreadyExists.t | `FileSystemLimitExceeded of FileSystemLimitExceeded.t | `InsufficientThroughputCapacity of InsufficientThroughputCapacity.t | `InternalServerError of InternalServerError.t | `ThroughputLimitExceeded of ThroughputLimitExceeded.t | `Unknown_operation_error of string * string option | `UnsupportedAvailabilityZone of UnsupportedAvailabilityZone.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Encrypted.t | `Double of ProvisionedThroughputInMibps.t | `Enum of string | `Integer of MountTargetCount.t | `List of [> `Structure of (string * [> `String of TagKey.t ]) list ] list | `String of AwsAccountId.t | `Structure of (string * [> `Enum of string | `Long of FileSystemSizeValue.t | `Timestamp of Timestamp.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t