Transfer / Client / start_remote_delete

start_remote_delete

Transfer.Client.start_remote_delete(**kwargs)

Deletes a file or directory on the remote SFTP server.

See also: AWS API Documentation

Request Syntax

response = client.start_remote_delete(
    ConnectorId='string',
    DeletePath='string'
)
Parameters:

  • ConnectorId (string) –

    [REQUIRED]

    The unique identifier for the connector.

  • DeletePath (string) –

    [REQUIRED]

    The absolute path of the file or directory to delete. You can only specify one path per call to this operation.

Return type:

dict

Returns:

Response Syntax

{
    'DeleteId': 'string'
}

Response Structure

  • (dict) –

    • DeleteId (string) –

      Returns a unique identifier for the delete operation.

Exceptions