Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Begins an outbound file transfer to a remote AS2 server. You specify the
ConnectorId
and the file paths for where to send the files.
Synopsis
- data StartFileTransfer = StartFileTransfer' {}
- newStartFileTransfer :: Text -> NonEmpty Text -> StartFileTransfer
- startFileTransfer_connectorId :: Lens' StartFileTransfer Text
- startFileTransfer_sendFilePaths :: Lens' StartFileTransfer (NonEmpty Text)
- data StartFileTransferResponse = StartFileTransferResponse' {
- httpStatus :: Int
- transferId :: Text
- newStartFileTransferResponse :: Int -> Text -> StartFileTransferResponse
- startFileTransferResponse_httpStatus :: Lens' StartFileTransferResponse Int
- startFileTransferResponse_transferId :: Lens' StartFileTransferResponse Text
Creating a Request
data StartFileTransfer Source #
See: newStartFileTransfer
smart constructor.
StartFileTransfer' | |
|
Instances
Create a value of StartFileTransfer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartFileTransfer
, startFileTransfer_connectorId
- The unique identifier for the connector.
$sel:sendFilePaths:StartFileTransfer'
, startFileTransfer_sendFilePaths
- An array of strings. Each string represents the absolute path for one
outbound file transfer. For example,
DOC-EXAMPLE-BUCKET
/
myfile.txt
.
Request Lenses
startFileTransfer_connectorId :: Lens' StartFileTransfer Text Source #
The unique identifier for the connector.
startFileTransfer_sendFilePaths :: Lens' StartFileTransfer (NonEmpty Text) Source #
An array of strings. Each string represents the absolute path for one
outbound file transfer. For example,
DOC-EXAMPLE-BUCKET
/
myfile.txt
.
Destructuring the Response
data StartFileTransferResponse Source #
See: newStartFileTransferResponse
smart constructor.
StartFileTransferResponse' | |
|
Instances
newStartFileTransferResponse Source #
:: Int | |
-> Text | |
-> StartFileTransferResponse |
Create a value of StartFileTransferResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartFileTransferResponse'
, startFileTransferResponse_httpStatus
- The response's http status code.
$sel:transferId:StartFileTransferResponse'
, startFileTransferResponse_transferId
- Returns the unique identifier for this file transfer.
Response Lenses
startFileTransferResponse_httpStatus :: Lens' StartFileTransferResponse Int Source #
The response's http status code.
startFileTransferResponse_transferId :: Lens' StartFileTransferResponse Text Source #
Returns the unique identifier for this file transfer.