2026/04/07 - Amazon S3 Files - 21 new api methods
Changes Support for S3 Files, a new shared file system that connects any AWS compute directly with your data in Amazon S3. It provides fast, direct access to all of your S3 data as files with full file system semantics and low-latency performance, without your data ever leaving S3.
Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the resource to add tags to.
list
[REQUIRED]
An array of key-value pairs to add as tags to the resource.
(dict) --
A key-value pair for resource tagging.
key (string) -- [REQUIRED]
The tag key. The key can't start with aws:.
value (string) -- [REQUIRED]
The tag value.
None
Returns resource information for all S3 File System Access Points associated with the specified S3 File System.
See also: AWS API Documentation
Request Syntax
client.list_access_points(
fileSystemId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.
integer
The maximum number of access points to return in a single response.
string
A pagination token returned from a previous call to continue listing access points.
dict
Response Syntax
{
'nextToken': 'string',
'accessPoints': [
{
'accessPointArn': 'string',
'accessPointId': 'string',
'fileSystemId': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'ownerId': 'string',
'posixUser': {
'uid': 123,
'gid': 123,
'secondaryGids': [
123,
]
},
'rootDirectory': {
'path': 'string',
'creationPermissions': {
'ownerUid': 123,
'ownerGid': 123,
'permissions': 'string'
}
},
'name': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A pagination token to use in a subsequent request if more results are available.
accessPoints (list) --
An array of access point descriptions.
(dict) --
Contains information about an S3 File System Access Point returned in list operations.
accessPointArn (string) --
The Amazon Resource Name (ARN) of the access point.
accessPointId (string) --
The ID of the access point.
fileSystemId (string) --
The ID of the S3 File System.
status (string) --
The current status of the access point.
ownerId (string) --
The Amazon Web Services account ID of the access point owner.
posixUser (dict) --
The POSIX identity configured for this access point.
uid (integer) --
The POSIX user ID.
gid (integer) --
The POSIX group ID.
secondaryGids (list) --
An array of secondary POSIX group IDs.
(integer) --
rootDirectory (dict) --
The root directory configuration for this access point.
path (string) --
The path to use as the root directory for the access point.
creationPermissions (dict) --
The permissions to set on newly created directories.
ownerUid (integer) --
The POSIX user ID to assign to newly created directories.
ownerGid (integer) --
The POSIX group ID to assign to newly created directories.
permissions (string) --
The octal permissions to assign to newly created directories.
name (string) --
The name of the access point.
Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.
See also: AWS API Documentation
Request Syntax
client.list_mount_targets(
fileSystemId='string',
accessPointId='string',
maxResults=123,
nextToken='string'
)
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.
string
Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).
integer
The maximum number of mount targets to return in a single response.
string
A pagination token returned from a previous call to continue listing mount targets.
dict
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.
Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.
See also: AWS API Documentation
Request Syntax
client.create_mount_target(
fileSystemId='string',
subnetId='string',
ipv4Address='string',
ipv6Address='string',
ipAddressType='IPV4_ONLY'|'IPV6_ONLY'|'DUAL_STACK',
securityGroups=[
'string',
]
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.
string
[REQUIRED]
The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon Web Services Region as the file system. For file systems with regional availability, you can create mount targets in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.
string
A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet's available IPv4 address range. The address must be within the subnet's CIDR block and not already in use.
string
A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet's available IPv6 address range. The address must be within the subnet's IPv6 CIDR block and not already in use.
string
The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type must match the IP configuration of the specified subnet.
list
An array of VPC security group IDs to associate with the mount target's network interface. These security groups control network access to the mount target. If not specified, the default security group for the subnet's VPC is used. All security groups must belong to the same VPC as the subnet.
(string) --
dict
Response Syntax
{
'availabilityZoneId': 'string',
'ownerId': 'string',
'mountTargetId': 'string',
'fileSystemId': 'string',
'subnetId': 'string',
'ipv4Address': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'vpcId': 'string',
'securityGroups': [
'string',
],
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string'
}
Response Structure
(dict) --
availabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone where the mount target is located. 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.
ownerId (string) --
The Amazon Web Services account ID of the mount target owner.
mountTargetId (string) --
The ID of the mount target, assigned by S3 Files. This ID is used to reference the mount target in subsequent API calls.
fileSystemId (string) --
The ID of the S3 File System associated with the mount target.
subnetId (string) --
The ID of the subnet where the mount target is located.
ipv4Address (string) --
The IPv4 address assigned to the mount target.
ipv6Address (string) --
The IPv6 address assigned to the mount target.
networkInterfaceId (string) --
The ID of the network interface that S3 Files created when it created the mount target. This network interface is managed by the service.
vpcId (string) --
The ID of the VPC where the mount target is located.
securityGroups (list) --
The security groups associated with the mount target's network interface.
(string) --
status (string) --
The lifecycle state of the mount target. Valid values are: AVAILABLE (the mount target is available for use), CREATING (the mount target is being created), DELETING (the mount target is being deleted), DELETED (the mount target has been deleted), or ERROR (the mount target is in an error state), or UPDATING (the mount target is being updated).
statusMessage (string) --
Additional information about the mount target status. This field provides more details when the status is ERROR, or during state transitions.
Returns the IAM resource policy of an S3 File System.
See also: AWS API Documentation
Request Syntax
client.get_file_system_policy(
fileSystemId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to retrieve.
dict
Response Syntax
{
'fileSystemId': 'string',
'policy': 'string'
}
Response Structure
(dict) --
fileSystemId (string) --
The ID of the file system.
policy (string) --
The JSON-formatted resource policy for the file system.
Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.
See also: AWS API Documentation
Request Syntax
client.create_file_system(
bucket='string',
prefix='string',
clientToken='string',
kmsKeyId='string',
roleArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
acceptBucketWarning=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.
string
An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.
string
A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
This field is autopopulated if not provided.
string
The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted.
string
[REQUIRED]
The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.
list
An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.
(dict) --
A key-value pair for resource tagging.
key (string) -- [REQUIRED]
The tag key. The key can't start with aws:.
value (string) -- [REQUIRED]
The tag value.
boolean
Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.
dict
Response Syntax
{
'creationTime': datetime(2015, 1, 1),
'fileSystemArn': 'string',
'fileSystemId': 'string',
'bucket': 'string',
'prefix': 'string',
'clientToken': 'string',
'kmsKeyId': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string',
'roleArn': 'string',
'ownerId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'name': 'string'
}
Response Structure
(dict) --
creationTime (datetime) --
The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).
fileSystemArn (string) --
The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id.
fileSystemId (string) --
The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.
bucket (string) --
The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.
prefix (string) --
The prefix within the S3 bucket that scopes the file system access.
clientToken (string) --
The client token used for idempotency.
kmsKeyId (string) --
The ARN or alias of the KMS key used for encryption.
status (string) --
The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).
statusMessage (string) --
Additional information about the file system status. This field provides more details when the status is ERROR, or during state transitions.
roleArn (string) --
The ARN of the IAM role used for S3 access.
ownerId (string) --
The Amazon Web Services account ID of the file system owner.
tags (list) --
The tags associated with the file system.
(dict) --
A key-value pair for resource tagging.
key (string) --
The tag key. The key can't start with aws:.
value (string) --
The tag value.
name (string) --
The name of the file system, derived from the Name tag if present.
Lists all tags for S3 Files resources.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the resource to list tags for.
integer
The maximum number of tags to return in a single response.
string
A pagination token returned from a previous call to continue listing tags.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
An array of tags associated with the resource.
(dict) --
A key-value pair for resource tagging.
key (string) --
The tag key. The key can't start with aws:.
value (string) --
The tag value.
nextToken (string) --
A pagination token to use in a subsequent request if more results are available.
Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.
See also: AWS API Documentation
Request Syntax
client.create_access_point(
clientToken='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
fileSystemId='string',
posixUser={
'uid': 123,
'gid': 123,
'secondaryGids': [
123,
]
},
rootDirectory={
'path': 'string',
'creationPermissions': {
'ownerUid': 123,
'ownerGid': 123,
'permissions': 'string'
}
}
)
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Web Services ignores the request, but does not return an error.
This field is autopopulated if not provided.
list
An array of key-value pairs to apply to the access point for resource tagging.
(dict) --
A key-value pair for resource tagging.
key (string) -- [REQUIRED]
The tag key. The key can't start with aws:.
value (string) -- [REQUIRED]
The tag value.
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System.
dict
The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point.
uid (integer) -- [REQUIRED]
The POSIX user ID.
gid (integer) -- [REQUIRED]
The POSIX group ID.
secondaryGids (list) --
An array of secondary POSIX group IDs.
(integer) --
dict
The root directory path for the access point, with optional creation permissions for newly created directories.
path (string) --
The path to use as the root directory for the access point.
creationPermissions (dict) --
The permissions to set on newly created directories.
ownerUid (integer) -- [REQUIRED]
The POSIX user ID to assign to newly created directories.
ownerGid (integer) -- [REQUIRED]
The POSIX group ID to assign to newly created directories.
permissions (string) -- [REQUIRED]
The octal permissions to assign to newly created directories.
dict
Response Syntax
{
'accessPointArn': 'string',
'accessPointId': 'string',
'clientToken': 'string',
'fileSystemId': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'ownerId': 'string',
'posixUser': {
'uid': 123,
'gid': 123,
'secondaryGids': [
123,
]
},
'rootDirectory': {
'path': 'string',
'creationPermissions': {
'ownerUid': 123,
'ownerGid': 123,
'permissions': 'string'
}
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'name': 'string'
}
Response Structure
(dict) --
accessPointArn (string) --
The Amazon Resource Name (ARN) of the access point.
accessPointId (string) --
The ID of the access point.
clientToken (string) --
The client token that was provided in the request.
fileSystemId (string) --
The ID of the S3 File System.
status (string) --
The current status of the access point.
ownerId (string) --
The Amazon Web Services account ID of the access point owner.
posixUser (dict) --
The POSIX identity configured for this access point.
uid (integer) --
The POSIX user ID.
gid (integer) --
The POSIX group ID.
secondaryGids (list) --
An array of secondary POSIX group IDs.
(integer) --
rootDirectory (dict) --
The root directory configuration for this access point.
path (string) --
The path to use as the root directory for the access point.
creationPermissions (dict) --
The permissions to set on newly created directories.
ownerUid (integer) --
The POSIX user ID to assign to newly created directories.
ownerGid (integer) --
The POSIX group ID to assign to newly created directories.
permissions (string) --
The octal permissions to assign to newly created directories.
tags (list) --
The tags associated with the access point.
(dict) --
A key-value pair for resource tagging.
key (string) --
The tag key. The key can't start with aws:.
value (string) --
The tag value.
name (string) --
The name of the access point.
Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.
See also: AWS API Documentation
Request Syntax
client.list_file_systems(
bucket='string',
maxResults=123,
nextToken='string'
)
string
Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.
integer
The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.
string
A pagination token returned from a previous call to continue listing file systems.
dict
Response Syntax
{
'nextToken': 'string',
'fileSystems': [
{
'creationTime': datetime(2015, 1, 1),
'fileSystemArn': 'string',
'fileSystemId': 'string',
'name': 'string',
'bucket': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string',
'roleArn': 'string',
'ownerId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A pagination token to use in a subsequent request if more results are available.
fileSystems (list) --
An array of file system descriptions.
(dict) --
Contains information about an S3 File System returned in list operations.
creationTime (datetime) --
The time when the file system was created.
fileSystemArn (string) --
The Amazon Resource Name (ARN) of the file system.
fileSystemId (string) --
The ID of the file system.
name (string) --
The name of the file system.
bucket (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
status (string) --
The current status of the file system.
statusMessage (string) --
Additional information about the file system status.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for S3 access.
ownerId (string) --
The Amazon Web Services account ID of the file system owner.
Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
See also: AWS API Documentation
Request Syntax
client.put_synchronization_configuration(
fileSystemId='string',
latestVersionNumber=123,
importDataRules=[
{
'prefix': 'string',
'trigger': 'ON_DIRECTORY_FIRST_ACCESS'|'ON_FILE_ACCESS',
'sizeLessThan': 123
},
],
expirationDataRules=[
{
'daysAfterLastAccess': 123
},
]
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to configure synchronization for.
integer
The version number of the current synchronization configuration. Omit this value when creating a synchronization configuration for the first time. For subsequent updates, provide this value for optimistic concurrency control. If the version number does not match the current configuration, the request fails with a ConflictException.
list
[REQUIRED]
An array of import data rules that control how data is imported from S3 into the file system.
(dict) --
Specifies a rule that controls how data is imported from S3 into the file system.
prefix (string) -- [REQUIRED]
The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.
trigger (string) -- [REQUIRED]
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).
sizeLessThan (integer) -- [REQUIRED]
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.
list
[REQUIRED]
An array of expiration data rules that control when cached data expires from the file system.
(dict) --
Specifies a rule that controls when cached data expires from the file system based on last access time.
daysAfterLastAccess (integer) -- [REQUIRED]
The number of days after last access before cached data expires from the file system.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates or replaces the IAM resource policy for an S3 File System to control access permissions.
See also: AWS API Documentation
Request Syntax
client.put_file_system_policy(
fileSystemId='string',
policy='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to apply the resource policy to.
string
[REQUIRED]
The JSON-formatted resource policy to apply to the file system. The policy defines the permissions for accessing the file system. The policy must be a valid JSON document that follows IAM policy syntax.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.
See also: AWS API Documentation
Request Syntax
client.delete_file_system(
fileSystemId='string',
forceDelete=True|False
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to delete.
boolean
If true, allows deletion of a file system that contains data pending export to S3. If false (the default), the deletion will fail if there is data that has not yet been exported to the S3 bucket. Use this parameter with caution as it may result in data loss.
None
Updates the mount target resource, specifically security group configurations.
See also: AWS API Documentation
Request Syntax
client.update_mount_target(
mountTargetId='string',
securityGroups=[
'string',
]
)
string
[REQUIRED]
The ID of the mount target to update.
list
[REQUIRED]
An array of VPC security group IDs to associate with the mount target's network interface. This replaces the existing security groups. All security groups must belong to the same VPC as the mount target's subnet.
(string) --
dict
Response Syntax
{
'availabilityZoneId': 'string',
'ownerId': 'string',
'mountTargetId': 'string',
'fileSystemId': 'string',
'subnetId': 'string',
'ipv4Address': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'vpcId': 'string',
'securityGroups': [
'string',
],
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string'
}
Response Structure
(dict) --
availabilityZoneId (string) --
The Availability Zone ID where the mount target is located.
ownerId (string) --
The Amazon Web Services account ID of the mount target owner.
mountTargetId (string) --
The ID of the mount target.
fileSystemId (string) --
The ID of the S3 File System.
subnetId (string) --
The ID of the subnet where the mount target is located.
ipv4Address (string) --
The IPv4 address of the mount target.
ipv6Address (string) --
The IPv6 address of the mount target.
networkInterfaceId (string) --
The ID of the network interface associated with the mount target.
vpcId (string) --
The ID of the VPC where the mount target is located.
securityGroups (list) --
The security groups associated with the mount target.
(string) --
status (string) --
The current status of the mount target.
statusMessage (string) --
Additional information about the mount target status.
Deletes an S3 File System Access Point. This operation is irreversible.
See also: AWS API Documentation
Request Syntax
client.delete_access_point(
accessPointId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the access point to delete.
None
Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
See also: AWS API Documentation
Request Syntax
client.get_synchronization_configuration(
fileSystemId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve the synchronization configuration for.
dict
Response Syntax
{
'latestVersionNumber': 123,
'importDataRules': [
{
'prefix': 'string',
'trigger': 'ON_DIRECTORY_FIRST_ACCESS'|'ON_FILE_ACCESS',
'sizeLessThan': 123
},
],
'expirationDataRules': [
{
'daysAfterLastAccess': 123
},
]
}
Response Structure
(dict) --
latestVersionNumber (integer) --
The version number of the synchronization configuration. Use this value with PutSynchronizationConfiguration to ensure optimistic concurrency control.
importDataRules (list) --
An array of import data rules that control how data is imported from S3 into the file system.
(dict) --
Specifies a rule that controls how data is imported from S3 into the file system.
prefix (string) --
The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.
trigger (string) --
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).
sizeLessThan (integer) --
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.
expirationDataRules (list) --
An array of expiration data rules that control when cached data expires from the file system.
(dict) --
Specifies a rule that controls when cached data expires from the file system based on last access time.
daysAfterLastAccess (integer) --
The number of days after last access before cached data expires from the file system.
Returns resource information for an S3 File System Access Point.
See also: AWS API Documentation
Request Syntax
client.get_access_point(
accessPointId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the access point to retrieve information for.
dict
Response Syntax
{
'accessPointArn': 'string',
'accessPointId': 'string',
'clientToken': 'string',
'fileSystemId': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'ownerId': 'string',
'posixUser': {
'uid': 123,
'gid': 123,
'secondaryGids': [
123,
]
},
'rootDirectory': {
'path': 'string',
'creationPermissions': {
'ownerUid': 123,
'ownerGid': 123,
'permissions': 'string'
}
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'name': 'string'
}
Response Structure
(dict) --
accessPointArn (string) --
The ARN of the access point.
accessPointId (string) --
The ID of the access point.
clientToken (string) --
The client token used for idempotency when the access point was created.
fileSystemId (string) --
The ID of the S3 File System.
status (string) --
The current status of the access point.
ownerId (string) --
The Amazon Web Services account ID of the access point owner.
posixUser (dict) --
The POSIX identity configured for this access point.
uid (integer) --
The POSIX user ID.
gid (integer) --
The POSIX group ID.
secondaryGids (list) --
An array of secondary POSIX group IDs.
(integer) --
rootDirectory (dict) --
The root directory configuration for this access point.
path (string) --
The path to use as the root directory for the access point.
creationPermissions (dict) --
The permissions to set on newly created directories.
ownerUid (integer) --
The POSIX user ID to assign to newly created directories.
ownerGid (integer) --
The POSIX group ID to assign to newly created directories.
permissions (string) --
The octal permissions to assign to newly created directories.
tags (list) --
The tags associated with the access point.
(dict) --
A key-value pair for resource tagging.
key (string) --
The tag key. The key can't start with aws:.
value (string) --
The tag value.
name (string) --
The name of the access point.
Returns resource information for the specified S3 File System including status, configuration, and metadata.
See also: AWS API Documentation
Request Syntax
client.get_file_system(
fileSystemId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.
dict
Response Syntax
{
'creationTime': datetime(2015, 1, 1),
'fileSystemArn': 'string',
'fileSystemId': 'string',
'bucket': 'string',
'prefix': 'string',
'clientToken': 'string',
'kmsKeyId': 'string',
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string',
'roleArn': 'string',
'ownerId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'name': 'string'
}
Response Structure
(dict) --
creationTime (datetime) --
The time when the file system was created.
fileSystemArn (string) --
The Amazon Resource Name (ARN) of the file system.
fileSystemId (string) --
The ID of the file system.
bucket (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
prefix (string) --
The prefix in the S3 bucket that the file system provides access to.
clientToken (string) --
The client token used for idempotency when the file system was created.
kmsKeyId (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.
status (string) --
The current status of the file system.
statusMessage (string) --
Additional information about the file system status.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for S3 access.
ownerId (string) --
The Amazon Web Services account ID of the file system owner.
tags (list) --
The tags associated with the file system.
(dict) --
A key-value pair for resource tagging.
key (string) --
The tag key. The key can't start with aws:.
value (string) --
The tag value.
name (string) --
The name of the file system.
Deletes the IAM resource policy of an S3 File System.
See also: AWS API Documentation
Request Syntax
client.delete_file_system_policy(
fileSystemId='string'
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to delete.
None
Returns detailed resource information for the specified mount target including network configuration.
See also: AWS API Documentation
Request Syntax
client.get_mount_target(
mountTargetId='string'
)
string
[REQUIRED]
The ID of the mount target to retrieve information for.
dict
Response Syntax
{
'availabilityZoneId': 'string',
'ownerId': 'string',
'mountTargetId': 'string',
'fileSystemId': 'string',
'subnetId': 'string',
'ipv4Address': 'string',
'ipv6Address': 'string',
'networkInterfaceId': 'string',
'vpcId': 'string',
'securityGroups': [
'string',
],
'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
'statusMessage': 'string'
}
Response Structure
(dict) --
availabilityZoneId (string) --
The Availability Zone ID where the mount target is located.
ownerId (string) --
The Amazon Web Services account ID of the mount target owner.
mountTargetId (string) --
The ID of the mount target.
fileSystemId (string) --
The ID of the file system.
subnetId (string) --
The ID of the subnet where the mount target is located.
ipv4Address (string) --
The IPv4 address of the mount target.
ipv6Address (string) --
The IPv6 address of the mount target.
networkInterfaceId (string) --
The ID of the network interface associated with the mount target.
vpcId (string) --
The ID of the VPC where the mount target is located.
securityGroups (list) --
The security groups associated with the mount target.
(string) --
status (string) --
The current status of the mount target.
statusMessage (string) --
Additional information about the mount target status.
Removes tags from S3 Files resources.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceId='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the resource to remove tags from.
list
[REQUIRED]
An array of tag keys to remove from the resource.
(string) --
None
Deletes the specified mount target. This operation is irreversible.
See also: AWS API Documentation
Request Syntax
client.delete_mount_target(
mountTargetId='string'
)
string
[REQUIRED]
The ID of the mount target to delete.
None