Skip to content

list_file_systems 

list_file_systems(
    *,
    config_overrides: Optional[S3FilesClientConfig] = None,
    bucket: Optional[BucketArn] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListFileSystemsResponse

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

Parameters:

  • bucket (Optional[BucketArn], default: None ) –

    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.

  • max_results (Optional[int], default: None ) –

    The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.

  • next_token (Optional[str], default: None ) –

    A pagination token returned from a previous call to continue listing file systems.

Raises:

Source code in docs_src/capo_s3files/_services/s3_files.py 
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
def list_file_systems(
    self,
    *,
    config_overrides: Optional[S3FilesClientConfig] = None,
    bucket: Optional["capo_s3files.types.bucket_arn.BucketArn"] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_s3files.types.list_file_systems_response.ListFileSystemsResponse":
    """<p>Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.</p>

    Args:
        bucket: <p>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.</p>
        max_results: <p>The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.</p>
        next_token: <p>A pagination token returned from a previous call to continue listing file systems.</p>

    Raises:
        capo_s3files.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Retry your request using exponential backoff.</p>
        capo_s3files.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_s3files.errors.validation_exception.ValidationException: <p>The input parameters are not valid. Check the parameter values and try again.</p>
        capo_s3files.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3files.types.list_file_systems_request.ListFileSystemsRequest]",
    ) -> OperationResponse[
        "capo_s3files.types.list_file_systems_response.ListFileSystemsResponse"
    ]:
        import capo_s3files._operations.s3_files.list_file_systems

        output, http_response = (
            capo_s3files._operations.s3_files.list_file_systems.list_file_systems(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFileSystems")
    )
    input_: capo_s3files.types.list_file_systems_request.ListFileSystemsRequest = {}
    if bucket is not None:
        input_["bucket"] = bucket
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output