AWS Transfer Family

2025/04/07 - AWS Transfer Family - 2 new api methods

Changes  This launch enables customers to manage contents of their remote directories, by deleting old files or moving files to archive folders in remote servers once they have been retrieved. Customers will be able to automate the process using event-driven architecture.

StartRemoteMove (new) Link ¶

Moves or renames a file or directory on the remote SFTP server.

See also: AWS API Documentation

Request Syntax

client.start_remote_move(
    ConnectorId='string',
    SourcePath='string',
    TargetPath='string'
)
type ConnectorId:

string

param ConnectorId:

[REQUIRED]

The unique identifier for the connector.

type SourcePath:

string

param SourcePath:

[REQUIRED]

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

type TargetPath:

string

param TargetPath:

[REQUIRED]

The absolute path for the target of the move/rename operation.

rtype:

dict

returns:

Response Syntax

{
    'MoveId': 'string'
}

Response Structure

  • (dict) --

    • MoveId (string) --

      Returns a unique identifier for the move/rename operation.

StartRemoteDelete (new) Link ¶

Deletes a file or directory on the remote SFTP server.

See also: AWS API Documentation

Request Syntax

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

string

param ConnectorId:

[REQUIRED]

The unique identifier for the connector.

type DeletePath:

string

param DeletePath:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'DeleteId': 'string'
}

Response Structure

  • (dict) --

    • DeleteId (string) --

      Returns a unique identifier for the delete operation.