delete_file_system `async` ¶

delete_file_system(
    file_system_id: FileSystemId,
    *,
    config_overrides: Optional[AsyncEFSClientConfig] = None,
) -> None

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

You cannot delete a file system that is part of an EFS replication configuration. You need to delete the replication configuration first.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

Parameters:

file_system_id (FileSystemId) –

The ID of the file system you want to delete.

Raises:

BadRequest –

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
FileSystemInUse –

Returned if a file system has mount targets.
FileSystemNotFound –

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
InternalServerError –

Returned if an error occurred on the server side.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a file system This operation deletes an EFS file system.

>>> await client.delete_file_system(file_system_id='fs-01234567')

Source code in docs_src/capo_efs/_services/async_efs.py

async def delete_file_system(
    self,
    file_system_id: "capo_efs.types.file_system_id.FileSystemId",
    *,
    config_overrides: Optional[AsyncEFSClientConfig] = None,
) -> None:
    """<p>Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.</p> <p>You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.</p> <note> <p>You cannot delete a file system that is part of an EFS replication configuration. You need to delete the replication configuration first.</p> </note> <p> You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> <note> <p>The <code>DeleteFileSystem</code> call returns while the file system state is still <code>deleting</code>. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> returns a <code>404 FileSystemNotFound</code> error.</p> </note> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteFileSystem</code> action.</p>

    Args:
        file_system_id: <p>The ID of the file system you want to delete.</p>

    Raises:
        capo_efs.errors.bad_request.BadRequest: <p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
        capo_efs.errors.file_system_in_use.FileSystemInUse: <p>Returned if a file system has mount targets.</p>
        capo_efs.errors.file_system_not_found.FileSystemNotFound: <p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's Amazon Web Services account.</p>
        capo_efs.errors.internal_server_error.InternalServerError: <p>Returned if an error occurred on the server side.</p>
        capo_efs.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a file system
        This operation deletes an EFS file system.

        >>> await client.delete_file_system(file_system_id='fs-01234567')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_efs.types.delete_file_system_request.DeleteFileSystemRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_efs._operations.magnolio_api_service_v20150201.delete_file_system

        (
            output,
            http_response,
        ) = await capo_efs._operations.magnolio_api_service_v20150201.delete_file_system.async_delete_file_system(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteFileSystem")
    )
    input_: capo_efs.types.delete_file_system_request.DeleteFileSystemRequest = {
        "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

delete_file_system async ¶

delete_file_system `async` ¶