Skip to content

get_file_system async

get_file_system(
    file_system_id: FileSystemId,
    *,
    config_overrides: Optional[AsyncS3FilesClientConfig] = None,
) -> GetFileSystemResponse

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

Parameters:

  • file_system_id (FileSystemId) –

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

Raises:

Source code in docs_src/capo_s3files/_services/async_s3_files.py
async def get_file_system(
    self,
    file_system_id: "capo_s3files.types.file_system_id.FileSystemId",
    *,
    config_overrides: Optional[AsyncS3FilesClientConfig] = None,
) -> "capo_s3files.types.get_file_system_response.GetFileSystemResponse":
    """<p>Returns resource information for the specified S3 File System including status, configuration, and metadata.</p>

    Args:
        file_system_id: <p>The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource exists and that you have permission to access it.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_s3files.types.get_file_system_request.GetFileSystemRequest]",
    ) -> AsyncOperationResponse[
        "capo_s3files.types.get_file_system_response.GetFileSystemResponse"
    ]:
        import capo_s3files._operations.s3_files.get_file_system

        (
            output,
            http_response,
        ) = await capo_s3files._operations.s3_files.get_file_system.async_get_file_system(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFileSystem")
    )
    input_: capo_s3files.types.get_file_system_request.GetFileSystemRequest = {
        "file_system_id": file_system_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output