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

Amazonka.Transfer.StartFileTransfer

Contents

Description

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

Creating a Request

data StartFileTransfer Source #

See: newStartFileTransfer smart constructor.

Constructors

StartFileTransfer'
Fields connectorId :: Text The unique identifier for the connector. sendFilePaths :: NonEmpty Text An array of strings. Each string represents the absolute path for one outbound file transfer. For example, `DOC-EXAMPLE-BUCKET``/``myfile.txt` .

Instances

Instances details

ToJSON StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods toJSON :: StartFileTransfer -> Value # toEncoding :: StartFileTransfer -> Encoding # toJSONList :: [StartFileTransfer] -> Value # toEncodingList :: [StartFileTransfer] -> Encoding #
ToHeaders StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods toHeaders :: StartFileTransfer -> [Header] #
ToPath StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods toPath :: StartFileTransfer -> ByteString #
ToQuery StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods toQuery :: StartFileTransfer -> QueryString #
AWSRequest StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Associated Types type AWSResponse StartFileTransfer # Methods request :: (Service -> Service) -> StartFileTransfer -> Request StartFileTransfer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartFileTransfer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartFileTransfer))) #
Generic StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Associated Types type Rep StartFileTransfer :: Type -> Type # Methods from :: StartFileTransfer -> Rep StartFileTransfer x # to :: Rep StartFileTransfer x -> StartFileTransfer #
Read StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods readsPrec :: Int -> ReadS StartFileTransfer # readList :: ReadS [StartFileTransfer] # readPrec :: ReadPrec StartFileTransfer # readListPrec :: ReadPrec [StartFileTransfer] #
Show StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods showsPrec :: Int -> StartFileTransfer -> ShowS # show :: StartFileTransfer -> String # showList :: [StartFileTransfer] -> ShowS #
NFData StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods rnf :: StartFileTransfer -> () #
Eq StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods (==) :: StartFileTransfer -> StartFileTransfer -> Bool # (/=) :: StartFileTransfer -> StartFileTransfer -> Bool #
Hashable StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods hashWithSalt :: Int -> StartFileTransfer -> Int # hash :: StartFileTransfer -> Int #
type AWSResponse StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer type AWSResponse StartFileTransfer = StartFileTransferResponse
type Rep StartFileTransfer Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer type Rep StartFileTransfer = D1 ('MetaData "StartFileTransfer" "Amazonka.Transfer.StartFileTransfer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StartFileTransfer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendFilePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newStartFileTransfer Source #

Arguments

:: Text	`StartFileTransfer`
-> NonEmpty Text	`$sel:sendFilePaths:StartFileTransfer'`
-> StartFileTransfer

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.

Constructors

StartFileTransferResponse'
Fields httpStatus :: Int The response's http status code. transferId :: Text Returns the unique identifier for this file transfer.

Instances

Instances details

Generic StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Associated Types type Rep StartFileTransferResponse :: Type -> Type # Methods from :: StartFileTransferResponse -> Rep StartFileTransferResponse x # to :: Rep StartFileTransferResponse x -> StartFileTransferResponse #
Read StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods readsPrec :: Int -> ReadS StartFileTransferResponse # readList :: ReadS [StartFileTransferResponse] # readPrec :: ReadPrec StartFileTransferResponse # readListPrec :: ReadPrec [StartFileTransferResponse] #
Show StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods showsPrec :: Int -> StartFileTransferResponse -> ShowS # show :: StartFileTransferResponse -> String # showList :: [StartFileTransferResponse] -> ShowS #
NFData StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods rnf :: StartFileTransferResponse -> () #
Eq StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer Methods (==) :: StartFileTransferResponse -> StartFileTransferResponse -> Bool # (/=) :: StartFileTransferResponse -> StartFileTransferResponse -> Bool #
type Rep StartFileTransferResponse Source #
Instance details Defined in Amazonka.Transfer.StartFileTransfer type Rep StartFileTransferResponse = D1 ('MetaData "StartFileTransferResponse" "Amazonka.Transfer.StartFileTransfer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StartFileTransferResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "transferId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartFileTransferResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartFileTransferResponse'`
-> Text	`$sel:transferId:StartFileTransferResponse'`
-> 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.