start_file_transfer

Transfer.Client.start_file_transfer(**kwargs)

Begins an outbound file transfer to a remote AS2 server. You specify the ConnectorId and the file paths for where to send the files.

See also: AWS API Documentation

Request Syntax

response = client.start_file_transfer(
    ConnectorId='string',
    SendFilePaths=[
        'string',
    ]
)

Parameters

• ConnectorId (string) --

  [REQUIRED]

  The unique identifier for the connector.

• SendFilePaths (list) --

  [REQUIRED]

  An array of strings. Each string represents the absolute path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

  • (string) --

Return type

dict

Returns

Response Syntax

{
    'TransferId': 'string'
}

Response Structure

• (dict) --

  • TransferId (string) --

    Returns the unique identifier for this file transfer.

Exceptions

• Transfer.Client.exceptions.ServiceUnavailableException
• Transfer.Client.exceptions.InternalServiceError
• Transfer.Client.exceptions.InvalidRequestException
• Transfer.Client.exceptions.ResourceNotFoundException
• Transfer.Client.exceptions.ThrottlingException