S3FilesClient

Index > S3Files > S3FilesClient

Auto-generated documentation for S3Files type annotations stubs module mypy-boto3-s3files.

S3FilesClient

Type annotations and code completion for boto3.client("s3files"). boto3 documentation

# S3FilesClient usage example

from boto3.session import Session
from mypy_boto3_s3files.client import S3FilesClient

def get_s3files_client() -> S3FilesClient:
    return Session().client("s3files")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("s3files").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("s3files")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_s3files.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("s3files").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("s3files").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_access_point

Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement.

Type annotations and code completion for boto3.client("s3files").create_access_point method. boto3 documentation

# create_access_point method definition

def create_access_point(
    self,
    *,
    fileSystemId: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    posixUser: PosixUserUnionTypeDef = ...,  # (2)
    rootDirectory: RootDirectoryTypeDef = ...,  # (3)
) -> CreateAccessPointResponseTypeDef:  # (4)
    ...

1. See Sequence[TagTypeDef]
2. See PosixUserUnionTypeDef
3. See RootDirectoryTypeDef
4. See CreateAccessPointResponseTypeDef

# create_access_point method usage example with argument unpacking

kwargs: CreateAccessPointRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.create_access_point(**kwargs)

1. See CreateAccessPointRequestTypeDef

create_file_system

Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data.

Type annotations and code completion for boto3.client("s3files").create_file_system method. boto3 documentation

# create_file_system method definition

def create_file_system(
    self,
    *,
    bucket: str,
    roleArn: str,
    prefix: str = ...,
    clientToken: str = ...,
    kmsKeyId: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    acceptBucketWarning: bool = ...,
) -> CreateFileSystemResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateFileSystemResponseTypeDef

# create_file_system method usage example with argument unpacking

kwargs: CreateFileSystemRequestTypeDef = {  # (1)
    "bucket": ...,
    "roleArn": ...,
}

parent.create_file_system(**kwargs)

1. See CreateFileSystemRequestTypeDef

create_mount_target

Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC.

Type annotations and code completion for boto3.client("s3files").create_mount_target method. boto3 documentation

# create_mount_target method definition

def create_mount_target(
    self,
    *,
    fileSystemId: str,
    subnetId: str,
    ipv4Address: str = ...,
    ipv6Address: str = ...,
    ipAddressType: IpAddressTypeType = ...,  # (1)
    securityGroups: Sequence[str] = ...,
) -> CreateMountTargetResponseTypeDef:  # (2)
    ...

1. See IpAddressTypeType
2. See CreateMountTargetResponseTypeDef

# create_mount_target method usage example with argument unpacking

kwargs: CreateMountTargetRequestTypeDef = {  # (1)
    "fileSystemId": ...,
    "subnetId": ...,
}

parent.create_mount_target(**kwargs)

1. See CreateMountTargetRequestTypeDef

delete_access_point

Deletes an S3 File System Access Point.

Type annotations and code completion for boto3.client("s3files").delete_access_point method. boto3 documentation

# delete_access_point method definition

def delete_access_point(
    self,
    *,
    accessPointId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_access_point method usage example with argument unpacking

kwargs: DeleteAccessPointRequestTypeDef = {  # (1)
    "accessPointId": ...,
}

parent.delete_access_point(**kwargs)

1. See DeleteAccessPointRequestTypeDef

delete_file_system

Deletes an S3 File System.

Type annotations and code completion for boto3.client("s3files").delete_file_system method. boto3 documentation

# delete_file_system method definition

def delete_file_system(
    self,
    *,
    fileSystemId: str,
    forceDelete: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_file_system method usage example with argument unpacking

kwargs: DeleteFileSystemRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.delete_file_system(**kwargs)

1. See DeleteFileSystemRequestTypeDef

delete_file_system_policy

Deletes the IAM resource policy of an S3 File System.

Type annotations and code completion for boto3.client("s3files").delete_file_system_policy method. boto3 documentation

# delete_file_system_policy method definition

def delete_file_system_policy(
    self,
    *,
    fileSystemId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_file_system_policy method usage example with argument unpacking

kwargs: DeleteFileSystemPolicyRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.delete_file_system_policy(**kwargs)

1. See DeleteFileSystemPolicyRequestTypeDef

delete_mount_target

Deletes the specified mount target.

Type annotations and code completion for boto3.client("s3files").delete_mount_target method. boto3 documentation

# delete_mount_target method definition

def delete_mount_target(
    self,
    *,
    mountTargetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_mount_target method usage example with argument unpacking

kwargs: DeleteMountTargetRequestTypeDef = {  # (1)
    "mountTargetId": ...,
}

parent.delete_mount_target(**kwargs)

1. See DeleteMountTargetRequestTypeDef

get_access_point

Returns resource information for an S3 File System Access Point.

Type annotations and code completion for boto3.client("s3files").get_access_point method. boto3 documentation

# get_access_point method definition

def get_access_point(
    self,
    *,
    accessPointId: str,
) -> GetAccessPointResponseTypeDef:  # (1)
    ...

1. See GetAccessPointResponseTypeDef

# get_access_point method usage example with argument unpacking

kwargs: GetAccessPointRequestTypeDef = {  # (1)
    "accessPointId": ...,
}

parent.get_access_point(**kwargs)

1. See GetAccessPointRequestTypeDef

get_file_system

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

Type annotations and code completion for boto3.client("s3files").get_file_system method. boto3 documentation

# get_file_system method definition

def get_file_system(
    self,
    *,
    fileSystemId: str,
) -> GetFileSystemResponseTypeDef:  # (1)
    ...

1. See GetFileSystemResponseTypeDef

# get_file_system method usage example with argument unpacking

kwargs: GetFileSystemRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.get_file_system(**kwargs)

1. See GetFileSystemRequestTypeDef

get_file_system_policy

Returns the IAM resource policy of an S3 File System.

Type annotations and code completion for boto3.client("s3files").get_file_system_policy method. boto3 documentation

# get_file_system_policy method definition

def get_file_system_policy(
    self,
    *,
    fileSystemId: str,
) -> GetFileSystemPolicyResponseTypeDef:  # (1)
    ...

1. See GetFileSystemPolicyResponseTypeDef

# get_file_system_policy method usage example with argument unpacking

kwargs: GetFileSystemPolicyRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.get_file_system_policy(**kwargs)

1. See GetFileSystemPolicyRequestTypeDef

get_mount_target

Returns detailed resource information for the specified mount target including network configuration.

Type annotations and code completion for boto3.client("s3files").get_mount_target method. boto3 documentation

# get_mount_target method definition

def get_mount_target(
    self,
    *,
    mountTargetId: str,
) -> GetMountTargetResponseTypeDef:  # (1)
    ...

1. See GetMountTargetResponseTypeDef

# get_mount_target method usage example with argument unpacking

kwargs: GetMountTargetRequestTypeDef = {  # (1)
    "mountTargetId": ...,
}

parent.get_mount_target(**kwargs)

1. See GetMountTargetRequestTypeDef

get_synchronization_configuration

Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Type annotations and code completion for boto3.client("s3files").get_synchronization_configuration method. boto3 documentation

# get_synchronization_configuration method definition

def get_synchronization_configuration(
    self,
    *,
    fileSystemId: str,
) -> GetSynchronizationConfigurationResponseTypeDef:  # (1)
    ...

1. See GetSynchronizationConfigurationResponseTypeDef

# get_synchronization_configuration method usage example with argument unpacking

kwargs: GetSynchronizationConfigurationRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.get_synchronization_configuration(**kwargs)

1. See GetSynchronizationConfigurationRequestTypeDef

list_access_points

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

Type annotations and code completion for boto3.client("s3files").list_access_points method. boto3 documentation

# list_access_points method definition

def list_access_points(
    self,
    *,
    fileSystemId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAccessPointsResponseTypeDef:  # (1)
    ...

1. See ListAccessPointsResponseTypeDef

# list_access_points method usage example with argument unpacking

kwargs: ListAccessPointsRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.list_access_points(**kwargs)

1. See ListAccessPointsRequestTypeDef

list_file_systems

Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.

Type annotations and code completion for boto3.client("s3files").list_file_systems method. boto3 documentation

# list_file_systems method definition

def list_file_systems(
    self,
    *,
    bucket: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFileSystemsResponseTypeDef:  # (1)
    ...

1. See ListFileSystemsResponseTypeDef

# list_file_systems method usage example with argument unpacking

kwargs: ListFileSystemsRequestTypeDef = {  # (1)
    "bucket": ...,
}

parent.list_file_systems(**kwargs)

1. See ListFileSystemsRequestTypeDef

list_mount_targets

Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

Type annotations and code completion for boto3.client("s3files").list_mount_targets method. boto3 documentation

# list_mount_targets method definition

def list_mount_targets(
    self,
    *,
    fileSystemId: str = ...,
    accessPointId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMountTargetsResponseTypeDef:  # (1)
    ...

1. See ListMountTargetsResponseTypeDef

# list_mount_targets method usage example with argument unpacking

kwargs: ListMountTargetsRequestTypeDef = {  # (1)
    "fileSystemId": ...,
}

parent.list_mount_targets(**kwargs)

1. See ListMountTargetsRequestTypeDef

list_tags_for_resource

Lists all tags for S3 Files resources.

Type annotations and code completion for boto3.client("s3files").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceId": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

put_file_system_policy

Creates or replaces the IAM resource policy for an S3 File System to control access permissions.

Type annotations and code completion for boto3.client("s3files").put_file_system_policy method. boto3 documentation

# put_file_system_policy method definition

def put_file_system_policy(
    self,
    *,
    fileSystemId: str,
    policy: str,
) -> dict[str, Any]:
    ...

# put_file_system_policy method usage example with argument unpacking

kwargs: PutFileSystemPolicyRequestTypeDef = {  # (1)
    "fileSystemId": ...,
    "policy": ...,
}

parent.put_file_system_policy(**kwargs)

1. See PutFileSystemPolicyRequestTypeDef

put_synchronization_configuration

Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Type annotations and code completion for boto3.client("s3files").put_synchronization_configuration method. boto3 documentation

# put_synchronization_configuration method definition

def put_synchronization_configuration(
    self,
    *,
    fileSystemId: str,
    importDataRules: Sequence[ImportDataRuleTypeDef],  # (1)
    expirationDataRules: Sequence[ExpirationDataRuleTypeDef],  # (2)
    latestVersionNumber: int = ...,
) -> dict[str, Any]:
    ...

1. See Sequence[ImportDataRuleTypeDef]
2. See Sequence[ExpirationDataRuleTypeDef]

# put_synchronization_configuration method usage example with argument unpacking

kwargs: PutSynchronizationConfigurationRequestTypeDef = {  # (1)
    "fileSystemId": ...,
    "importDataRules": ...,
    "expirationDataRules": ...,
}

parent.put_synchronization_configuration(**kwargs)

1. See PutSynchronizationConfigurationRequestTypeDef

tag_resource

Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.

Type annotations and code completion for boto3.client("s3files").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceId: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceId": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes tags from S3 Files resources.

Type annotations and code completion for boto3.client("s3files").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceId: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceId": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_mount_target

Updates the mount target resource, specifically security group configurations.

Type annotations and code completion for boto3.client("s3files").update_mount_target method. boto3 documentation

# update_mount_target method definition

def update_mount_target(
    self,
    *,
    mountTargetId: str,
    securityGroups: Sequence[str],
) -> UpdateMountTargetResponseTypeDef:  # (1)
    ...

1. See UpdateMountTargetResponseTypeDef

# update_mount_target method usage example with argument unpacking

kwargs: UpdateMountTargetRequestTypeDef = {  # (1)
    "mountTargetId": ...,
    "securityGroups": ...,
}

parent.update_mount_target(**kwargs)

1. See UpdateMountTargetRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("s3files").get_paginator method with overloads.

• client.get_paginator("list_access_points") -> ListAccessPointsPaginator
• client.get_paginator("list_file_systems") -> ListFileSystemsPaginator
• client.get_paginator("list_mount_targets") -> ListMountTargetsPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator