# Amazon S3 Files
<a name="API_Types_Amazon_S3_Files"></a>

The following data types are supported by Amazon S3 Files:
+  [CreationPermissions](API_S3Files_CreationPermissions.md) 
+  [ExpirationDataRule](API_S3Files_ExpirationDataRule.md) 
+  [ImportDataRule](API_S3Files_ImportDataRule.md) 
+  [ListAccessPointsDescription](API_S3Files_ListAccessPointsDescription.md) 
+  [ListFileSystemsDescription](API_S3Files_ListFileSystemsDescription.md) 
+  [ListMountTargetsDescription](API_S3Files_ListMountTargetsDescription.md) 
+  [PosixUser](API_S3Files_PosixUser.md) 
+  [RootDirectory](API_S3Files_RootDirectory.md) 
+  [Tag](API_S3Files_Tag.md) 

# CreationPermissions
<a name="API_S3Files_CreationPermissions"></a>

Specifies the permissions to set on newly created directories within the file system.

## Contents
<a name="API_S3Files_CreationPermissions_Contents"></a>

 ** ownerGid **   <a name="AmazonS3-Type-S3Files_CreationPermissions-ownerGid"></a>
The POSIX group ID to assign to newly created directories.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** ownerUid **   <a name="AmazonS3-Type-S3Files_CreationPermissions-ownerUid"></a>
The POSIX user ID to assign to newly created directories.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** permissions **   <a name="AmazonS3-Type-S3Files_CreationPermissions-permissions"></a>
The octal permissions to assign to newly created directories.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 4.  
Pattern: `[0-7]{3,4}`   
Required: Yes

## See Also
<a name="API_S3Files_CreationPermissions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/CreationPermissions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/CreationPermissions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/CreationPermissions) 

# ExpirationDataRule
<a name="API_S3Files_ExpirationDataRule"></a>

Specifies a rule that controls when cached data expires from the file system based on last access time.

## Contents
<a name="API_S3Files_ExpirationDataRule_Contents"></a>

 ** daysAfterLastAccess **   <a name="AmazonS3-Type-S3Files_ExpirationDataRule-daysAfterLastAccess"></a>
The number of days after last access before cached data expires from the file system.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 365.  
Required: Yes

## See Also
<a name="API_S3Files_ExpirationDataRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ExpirationDataRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ExpirationDataRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ExpirationDataRule) 

# ImportDataRule
<a name="API_S3Files_ImportDataRule"></a>

Specifies a rule that controls how data is imported from S3 into the file system.

## Contents
<a name="API_S3Files_ImportDataRule_Contents"></a>

 ** prefix **   <a name="AmazonS3-Type-S3Files_ImportDataRule-prefix"></a>
The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.  
Type: String  
Pattern: `(|.*/)`   
Required: Yes

 ** sizeLessThan **   <a name="AmazonS3-Type-S3Files_ImportDataRule-sizeLessThan"></a>
The upper size limit in bytes for this import rule. Only objects with a size strictly less than this value will have data imported into the file system.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 52673613135872.  
Required: Yes

 ** trigger **   <a name="AmazonS3-Type-S3Files_ImportDataRule-trigger"></a>
The event that triggers data import. Valid values are `ON_DIRECTORY_FIRST_ACCESS` (import when a directory is first accessed) and `ON_FILE_ACCESS` (import when a file is accessed).  
Type: String  
Valid Values: `ON_DIRECTORY_FIRST_ACCESS | ON_FILE_ACCESS`   
Required: Yes

## See Also
<a name="API_S3Files_ImportDataRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ImportDataRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ImportDataRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ImportDataRule) 

# ListAccessPointsDescription
<a name="API_S3Files_ListAccessPointsDescription"></a>

Contains information about an S3 File System Access Point returned in list operations.

## Contents
<a name="API_S3Files_ListAccessPointsDescription_Contents"></a>

 ** accessPointArn **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-accessPointArn"></a>
The Amazon Resource Name (ARN) of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}`   
Required: Yes

 ** accessPointId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-accessPointId"></a>
The ID of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}|fsap-[0-9a-f]{17,40})`   
Required: Yes

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-fileSystemId"></a>
The ID of the S3 File System.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-ownerId"></a>
The AWS account ID of the access point owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** status **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-status"></a>
The current status of the access point.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: Yes

 ** name **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-name"></a>
The name of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: No

 ** posixUser **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-posixUser"></a>
The POSIX identity configured for this access point.  
Type: [PosixUser](API_S3Files_PosixUser.md) object  
Required: No

 ** rootDirectory **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-rootDirectory"></a>
The root directory configuration for this access point.  
Type: [RootDirectory](API_S3Files_RootDirectory.md) object  
Required: No

## See Also
<a name="API_S3Files_ListAccessPointsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListAccessPointsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListAccessPointsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListAccessPointsDescription) 

# ListFileSystemsDescription
<a name="API_S3Files_ListFileSystemsDescription"></a>

Contains information about an S3 File System returned in list operations.

## Contents
<a name="API_S3Files_ListFileSystemsDescription_Contents"></a>

 ** bucket **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-bucket"></a>
The Amazon Resource Name (ARN) of the S3 bucket.  
Type: String  
Pattern: `(arn:aws[a-zA-Z0-9-]*:s3:::.+)`   
Required: Yes

 ** creationTime **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-creationTime"></a>
The time when the file system was created.  
Type: Timestamp  
Required: Yes

 ** fileSystemArn **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-fileSystemArn"></a>
The Amazon Resource Name (ARN) of the file system.  
Type: String  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40})`   
Required: Yes

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-fileSystemId"></a>
The ID of the file system.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-ownerId"></a>
The AWS account ID of the file system owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** roleArn **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM role used for S3 access.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

 ** status **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-status"></a>
The current status of the file system.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: Yes

 ** name **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-name"></a>
The name of the file system.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: No

 ** statusMessage **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-statusMessage"></a>
Additional information about the file system status.  
Type: String  
Required: No

## See Also
<a name="API_S3Files_ListFileSystemsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListFileSystemsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListFileSystemsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListFileSystemsDescription) 

# ListMountTargetsDescription
<a name="API_S3Files_ListMountTargetsDescription"></a>

Contains information about a mount target returned in list operations.

## Contents
<a name="API_S3Files_ListMountTargetsDescription_Contents"></a>

 ** mountTargetId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-mountTargetId"></a>
The ID of the mount target.  
Type: String  
Length Constraints: Minimum length of 22. Maximum length of 45.  
Pattern: `fsmt-[0-9a-f]{17,40}`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ownerId"></a>
The AWS account ID of the mount target owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** subnetId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-subnetId"></a>
The ID of the subnet where the mount target is located.  
Type: String  
Length Constraints: Minimum length of 15. Maximum length of 47.  
Pattern: `subnet-[0-9a-f]{8,40}`   
Required: Yes

 ** availabilityZoneId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-availabilityZoneId"></a>
The Availability Zone ID where the mount target is located.  
Type: String  
Required: No

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-fileSystemId"></a>
The ID of the S3 File System.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: No

 ** ipv4Address **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ipv4Address"></a>
The IPv4 address of the mount target.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}`   
Required: No

 ** ipv6Address **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ipv6Address"></a>
The IPv6 address of the mount target.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 39.  
Required: No

 ** networkInterfaceId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-networkInterfaceId"></a>
The ID of the network interface associated with the mount target.  
Type: String  
Required: No

 ** status **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-status"></a>
The current status of the mount target.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: No

 ** statusMessage **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-statusMessage"></a>
Additional information about the mount target status.  
Type: String  
Required: No

 ** vpcId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-vpcId"></a>
The ID of the VPC where the mount target is located.  
Type: String  
Required: No

## See Also
<a name="API_S3Files_ListMountTargetsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListMountTargetsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListMountTargetsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListMountTargetsDescription) 

# PosixUser
<a name="API_S3Files_PosixUser"></a>

Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.

## Contents
<a name="API_S3Files_PosixUser_Contents"></a>

 ** gid **   <a name="AmazonS3-Type-S3Files_PosixUser-gid"></a>
The POSIX group ID.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** uid **   <a name="AmazonS3-Type-S3Files_PosixUser-uid"></a>
The POSIX user ID.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** secondaryGids **   <a name="AmazonS3-Type-S3Files_PosixUser-secondaryGids"></a>
An array of secondary POSIX group IDs.  
Type: Array of longs  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: No

## See Also
<a name="API_S3Files_PosixUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/PosixUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/PosixUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/PosixUser) 

# RootDirectory
<a name="API_S3Files_RootDirectory"></a>

Specifies the root directory path and optional creation permissions for newly created directories.

## Contents
<a name="API_S3Files_RootDirectory_Contents"></a>

 ** creationPermissions **   <a name="AmazonS3-Type-S3Files_RootDirectory-creationPermissions"></a>
The permissions to set on newly created directories.  
Type: [CreationPermissions](API_S3Files_CreationPermissions.md) object  
Required: No

 ** path **   <a name="AmazonS3-Type-S3Files_RootDirectory-path"></a>
The path to use as the root directory for the access point.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(\/|(\/(?!\.)+[^$#<>;;`|&?{}^*/\n]+){1,4})`   
Required: No

## See Also
<a name="API_S3Files_RootDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/RootDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/RootDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/RootDirectory) 

# Tag
<a name="API_S3Files_Tag"></a>

A key-value pair for resource tagging.

## Contents
<a name="API_S3Files_Tag_Contents"></a>

 ** key **   <a name="AmazonS3-Type-S3Files_Tag-key"></a>
The tag key. The key can't start with `aws:`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]+)`   
Required: Yes

 ** value **   <a name="AmazonS3-Type-S3Files_Tag-value"></a>
The tag value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## See Also
<a name="API_S3Files_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/Tag)