Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
ConnectorId
and one or more SendFilePaths
to identify the files you want to transfer.ConnectorId
. Depending on the direction of the transfer, you also specify the following items:RetrieveFilePaths
to identify the files you want to transfer, and a LocalDirectoryPath
to specify the destination folder.SendFilePaths
to identify the files you want to transfer, and a RemoteDirectoryPath
to specify the destination folder.See also: AWS API Documentation
start-file-transfer
--connector-id <value>
[--send-file-paths <value>]
[--retrieve-file-paths <value>]
[--local-directory-path <value>]
[--remote-directory-path <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--connector-id
(string)
The unique identifier for the connector.
--send-file-paths
(list)
One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, `` DOC-EXAMPLE-BUCKET /myfile.txt `` .
Note
Replace `` DOC-EXAMPLE-BUCKET `` with one of your actual buckets.(string)
Syntax:
"string" "string" ...
--retrieve-file-paths
(list)
One or more source paths for the partner’s SFTP server. Each string represents a source file path for one inbound file transfer.
(string)
Syntax:
"string" "string" ...
--local-directory-path
(string)
For an inbound transfer, theLocaDirectoryPath
specifies the destination for one or more files that are transferred from the partner’s SFTP server.
--remote-directory-path
(string)
For an outbound transfer, theRemoteDirectoryPath
specifies the destination for one or more files that are transferred to the partner’s SFTP server. If you don’t specify aRemoteDirectoryPath
, the destination for transferred files is the SFTP user’s home directory.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.