Skip to content

DescribeFileSystem

Source: src/AWS/FSx/DescribeFileSystem.ts

Runtime binding for the DescribeFileSystems operation scoped to one file system (IAM action fsx:DescribeFileSystems on the file system ARN).

Reads the bound FileSystem’s live description — lifecycle state, storage capacity, DNS name, engine configuration — from inside a function runtime. Useful for storage dashboards and capacity monitors. Provide the implementation with Effect.provide(AWS.FSx.DescribeFileSystemHttp).

// init — bind the operation to the file system
const describeFileSystem = yield* AWS.FSx.DescribeFileSystem(files);
// runtime
const response = yield* describeFileSystem();
const fs = response.FileSystems?.[0];
yield* Effect.log(`${fs?.Lifecycle}: ${fs?.StorageCapacity} GiB`);