Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StartRemoteMove

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

Request Syntax


{
   "ConnectorId": "string",
   "SourcePath": "string",
   "TargetPath": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectorId

The unique identifier for the connector.

Type: String

Length Constraints: Fixed length of 19.

Pattern: c-([0-9a-f]{17})

Required: Yes

SourcePath

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: (.)+

Required: Yes

TargetPath

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: (.)+

Required: Yes

Response Syntax


{
   "MoveId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MoveId

Returns a unique identifier for the move/rename operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [0-9a-zA-Z./-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer Family service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

Examples

Example

The following example moves a file on the remote SFTP server from /source/folder/sourceFile to /destination/targetFile, and returns a unique identifier for the operation.


aws transfer --connector-id c-AAAA1111BBBB2222C start-remote-move \
   --source-path /source/folder/sourceFile --target-path /destination/targetFile