Transfer / Client / start_remote_move

start_remote_move

Transfer.Client.start_remote_move(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_remote_move(
    ConnectorId='string',
    SourcePath='string',
    TargetPath='string'
)
Parameters:
  • ConnectorId (string) –

    [REQUIRED]

    The unique identifier for the connector.

  • SourcePath (string) –

    [REQUIRED]

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

  • TargetPath (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'MoveId': 'string'
}

Response Structure

  • (dict) –

    • MoveId (string) –

      Returns a unique identifier for the move/rename operation.

Exceptions