Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142110684.3 KB

Returns resource information for the specified S3 File System including status, configuration, and metadata.

get/file-systems/{fileSystemId}

Path parameters

fileSystemIdstring required

The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.

Response

Success

creationTimestring date-time

The time when the file system was created.

fileSystemArnstring

The Amazon Resource Name (ARN) of the file system.

fileSystemIdstring

The ID of the file system.

bucketstring

The Amazon Resource Name (ARN) of the S3 bucket.

prefixstring

The prefix in the S3 bucket that the file system provides access to.

clientTokenstring

The client token used for idempotency when the file system was created.

kmsKeyIdstring

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.

status'available' | 'creating' | 'deleting' | 'deleted' | 'error' | 'updating'

The current status of the file system.

statusMessagestring

Additional information about the file system status.

roleArnstring

The Amazon Resource Name (ARN) of the IAM role used for S3 access.

ownerIdstring

The Amazon Web Services account ID of the file system owner.

namestring

The name of the file system.