Class As2

Hierarchy

As2Client
- As2

Implements

Implemented by

Constructors

constructor

new As2(configuration: As2ClientConfig): As2
Parameters
- configuration: As2ClientConfig
Returns As2
- Defined in clients/as2/src/As2Client.ts:335

Properties

`Readonly` config

config: As2ClientResolvedConfig

The resolved configuration of As2Client class. This is resolved and normalized from the constructor configuration interface.

Methods

createAgreement

createAgreement(args: CreateAgreementCommandInput, options?: HttpHandlerOptions): Promise<CreateAgreementCommandOutput>
See
CreateAgreementCommand
Parameters
- args: CreateAgreementCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateAgreementCommandOutput>
- Defined in clients/as2/src/As2.ts:160
createAgreement(args: CreateAgreementCommandInput, cb: ((err: any, data?: CreateAgreementCommandOutput) => void)): void
Parameters
- args: CreateAgreementCommandInput
- cb: ((err: any, data?: CreateAgreementCommandOutput) => void)
  - - (err: any, data?: CreateAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:164
createAgreement(args: CreateAgreementCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateAgreementCommandOutput) => void)): void
Parameters
- args: CreateAgreementCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateAgreementCommandOutput) => void)
  - - (err: any, data?: CreateAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:165

createConnector

createConnector(args: CreateConnectorCommandInput, options?: HttpHandlerOptions): Promise<CreateConnectorCommandOutput>
See
CreateConnectorCommand
Parameters
- args: CreateConnectorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateConnectorCommandOutput>
- Defined in clients/as2/src/As2.ts:174
createConnector(args: CreateConnectorCommandInput, cb: ((err: any, data?: CreateConnectorCommandOutput) => void)): void
Parameters
- args: CreateConnectorCommandInput
- cb: ((err: any, data?: CreateConnectorCommandOutput) => void)
  - - (err: any, data?: CreateConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:178
createConnector(args: CreateConnectorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateConnectorCommandOutput) => void)): void
Parameters
- args: CreateConnectorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateConnectorCommandOutput) => void)
  - - (err: any, data?: CreateConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:179

createProfile

createProfile(args: CreateProfileCommandInput, options?: HttpHandlerOptions): Promise<CreateProfileCommandOutput>
See
CreateProfileCommand
Parameters
- args: CreateProfileCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateProfileCommandOutput>
- Defined in clients/as2/src/As2.ts:188
createProfile(args: CreateProfileCommandInput, cb: ((err: any, data?: CreateProfileCommandOutput) => void)): void
Parameters
- args: CreateProfileCommandInput
- cb: ((err: any, data?: CreateProfileCommandOutput) => void)
  - - (err: any, data?: CreateProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:189
createProfile(args: CreateProfileCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateProfileCommandOutput) => void)): void
Parameters
- args: CreateProfileCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateProfileCommandOutput) => void)
  - - (err: any, data?: CreateProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:190

createServer

createServer(args: CreateServerCommandInput, options?: HttpHandlerOptions): Promise<CreateServerCommandOutput>
See
CreateServerCommand
Parameters
- args: CreateServerCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateServerCommandOutput>
- Defined in clients/as2/src/As2.ts:199
createServer(args: CreateServerCommandInput, cb: ((err: any, data?: CreateServerCommandOutput) => void)): void
Parameters
- args: CreateServerCommandInput
- cb: ((err: any, data?: CreateServerCommandOutput) => void)
  - - (err: any, data?: CreateServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:200
createServer(args: CreateServerCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateServerCommandOutput) => void)): void
Parameters
- args: CreateServerCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateServerCommandOutput) => void)
  - - (err: any, data?: CreateServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:201

deleteAgreement

deleteAgreement(args: DeleteAgreementCommandInput, options?: HttpHandlerOptions): Promise<DeleteAgreementCommandOutput>
See
DeleteAgreementCommand
Parameters
- args: DeleteAgreementCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteAgreementCommandOutput>
- Defined in clients/as2/src/As2.ts:210
deleteAgreement(args: DeleteAgreementCommandInput, cb: ((err: any, data?: DeleteAgreementCommandOutput) => void)): void
Parameters
- args: DeleteAgreementCommandInput
- cb: ((err: any, data?: DeleteAgreementCommandOutput) => void)
  - - (err: any, data?: DeleteAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:214
deleteAgreement(args: DeleteAgreementCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteAgreementCommandOutput) => void)): void
Parameters
- args: DeleteAgreementCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteAgreementCommandOutput) => void)
  - - (err: any, data?: DeleteAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:215

deleteCertificate

deleteCertificate(args: DeleteCertificateCommandInput, options?: HttpHandlerOptions): Promise<DeleteCertificateCommandOutput>
See
DeleteCertificateCommand
Parameters
- args: DeleteCertificateCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteCertificateCommandOutput>
- Defined in clients/as2/src/As2.ts:224
deleteCertificate(args: DeleteCertificateCommandInput, cb: ((err: any, data?: DeleteCertificateCommandOutput) => void)): void
Parameters
- args: DeleteCertificateCommandInput
- cb: ((err: any, data?: DeleteCertificateCommandOutput) => void)
  - - (err: any, data?: DeleteCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:228
deleteCertificate(args: DeleteCertificateCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteCertificateCommandOutput) => void)): void
Parameters
- args: DeleteCertificateCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteCertificateCommandOutput) => void)
  - - (err: any, data?: DeleteCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:232

deleteConnector

deleteConnector(args: DeleteConnectorCommandInput, options?: HttpHandlerOptions): Promise<DeleteConnectorCommandOutput>
See
DeleteConnectorCommand
Parameters
- args: DeleteConnectorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteConnectorCommandOutput>
- Defined in clients/as2/src/As2.ts:241
deleteConnector(args: DeleteConnectorCommandInput, cb: ((err: any, data?: DeleteConnectorCommandOutput) => void)): void
Parameters
- args: DeleteConnectorCommandInput
- cb: ((err: any, data?: DeleteConnectorCommandOutput) => void)
  - - (err: any, data?: DeleteConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:245
deleteConnector(args: DeleteConnectorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteConnectorCommandOutput) => void)): void
Parameters
- args: DeleteConnectorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteConnectorCommandOutput) => void)
  - - (err: any, data?: DeleteConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:246

deleteProfile

deleteProfile(args: DeleteProfileCommandInput, options?: HttpHandlerOptions): Promise<DeleteProfileCommandOutput>
See
DeleteProfileCommand
Parameters
- args: DeleteProfileCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteProfileCommandOutput>
- Defined in clients/as2/src/As2.ts:255
deleteProfile(args: DeleteProfileCommandInput, cb: ((err: any, data?: DeleteProfileCommandOutput) => void)): void
Parameters
- args: DeleteProfileCommandInput
- cb: ((err: any, data?: DeleteProfileCommandOutput) => void)
  - - (err: any, data?: DeleteProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:256
deleteProfile(args: DeleteProfileCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteProfileCommandOutput) => void)): void
Parameters
- args: DeleteProfileCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteProfileCommandOutput) => void)
  - - (err: any, data?: DeleteProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:257

deleteServer

deleteServer(args: DeleteServerCommandInput, options?: HttpHandlerOptions): Promise<DeleteServerCommandOutput>
See
DeleteServerCommand
Parameters
- args: DeleteServerCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteServerCommandOutput>
- Defined in clients/as2/src/As2.ts:266
deleteServer(args: DeleteServerCommandInput, cb: ((err: any, data?: DeleteServerCommandOutput) => void)): void
Parameters
- args: DeleteServerCommandInput
- cb: ((err: any, data?: DeleteServerCommandOutput) => void)
  - - (err: any, data?: DeleteServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:267
deleteServer(args: DeleteServerCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteServerCommandOutput) => void)): void
Parameters
- args: DeleteServerCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteServerCommandOutput) => void)
  - - (err: any, data?: DeleteServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:268

describeAgreement

describeAgreement(args: DescribeAgreementCommandInput, options?: HttpHandlerOptions): Promise<DescribeAgreementCommandOutput>
See
DescribeAgreementCommand
Parameters
- args: DescribeAgreementCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeAgreementCommandOutput>
- Defined in clients/as2/src/As2.ts:277
describeAgreement(args: DescribeAgreementCommandInput, cb: ((err: any, data?: DescribeAgreementCommandOutput) => void)): void
Parameters
- args: DescribeAgreementCommandInput
- cb: ((err: any, data?: DescribeAgreementCommandOutput) => void)
  - - (err: any, data?: DescribeAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:281
describeAgreement(args: DescribeAgreementCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeAgreementCommandOutput) => void)): void
Parameters
- args: DescribeAgreementCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeAgreementCommandOutput) => void)
  - - (err: any, data?: DescribeAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:285

describeCertificate

describeCertificate(args: DescribeCertificateCommandInput, options?: HttpHandlerOptions): Promise<DescribeCertificateCommandOutput>
See
DescribeCertificateCommand
Parameters
- args: DescribeCertificateCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeCertificateCommandOutput>
- Defined in clients/as2/src/As2.ts:294
describeCertificate(args: DescribeCertificateCommandInput, cb: ((err: any, data?: DescribeCertificateCommandOutput) => void)): void
Parameters
- args: DescribeCertificateCommandInput
- cb: ((err: any, data?: DescribeCertificateCommandOutput) => void)
  - - (err: any, data?: DescribeCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:298
describeCertificate(args: DescribeCertificateCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeCertificateCommandOutput) => void)): void
Parameters
- args: DescribeCertificateCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeCertificateCommandOutput) => void)
  - - (err: any, data?: DescribeCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:302

describeConnector

describeConnector(args: DescribeConnectorCommandInput, options?: HttpHandlerOptions): Promise<DescribeConnectorCommandOutput>
See
DescribeConnectorCommand
Parameters
- args: DescribeConnectorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeConnectorCommandOutput>
- Defined in clients/as2/src/As2.ts:311
describeConnector(args: DescribeConnectorCommandInput, cb: ((err: any, data?: DescribeConnectorCommandOutput) => void)): void
Parameters
- args: DescribeConnectorCommandInput
- cb: ((err: any, data?: DescribeConnectorCommandOutput) => void)
  - - (err: any, data?: DescribeConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:315
describeConnector(args: DescribeConnectorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeConnectorCommandOutput) => void)): void
Parameters
- args: DescribeConnectorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeConnectorCommandOutput) => void)
  - - (err: any, data?: DescribeConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:319

describeProfile

describeProfile(args: DescribeProfileCommandInput, options?: HttpHandlerOptions): Promise<DescribeProfileCommandOutput>
See
DescribeProfileCommand
Parameters
- args: DescribeProfileCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeProfileCommandOutput>
- Defined in clients/as2/src/As2.ts:328
describeProfile(args: DescribeProfileCommandInput, cb: ((err: any, data?: DescribeProfileCommandOutput) => void)): void
Parameters
- args: DescribeProfileCommandInput
- cb: ((err: any, data?: DescribeProfileCommandOutput) => void)
  - - (err: any, data?: DescribeProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:332
describeProfile(args: DescribeProfileCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeProfileCommandOutput) => void)): void
Parameters
- args: DescribeProfileCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeProfileCommandOutput) => void)
  - - (err: any, data?: DescribeProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:333

describeServer

describeServer(args: DescribeServerCommandInput, options?: HttpHandlerOptions): Promise<DescribeServerCommandOutput>
See
DescribeServerCommand
Parameters
- args: DescribeServerCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeServerCommandOutput>
- Defined in clients/as2/src/As2.ts:342
describeServer(args: DescribeServerCommandInput, cb: ((err: any, data?: DescribeServerCommandOutput) => void)): void
Parameters
- args: DescribeServerCommandInput
- cb: ((err: any, data?: DescribeServerCommandOutput) => void)
  - - (err: any, data?: DescribeServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:346
describeServer(args: DescribeServerCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeServerCommandOutput) => void)): void
Parameters
- args: DescribeServerCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeServerCommandOutput) => void)
  - - (err: any, data?: DescribeServerCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeServerCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:347

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void
- Defined in clients/as2/src/As2Client.ts:361

importCertificate

importCertificate(args: ImportCertificateCommandInput, options?: HttpHandlerOptions): Promise<ImportCertificateCommandOutput>
See
ImportCertificateCommand
Parameters
- args: ImportCertificateCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ImportCertificateCommandOutput>
- Defined in clients/as2/src/As2.ts:356
importCertificate(args: ImportCertificateCommandInput, cb: ((err: any, data?: ImportCertificateCommandOutput) => void)): void
Parameters
- args: ImportCertificateCommandInput
- cb: ((err: any, data?: ImportCertificateCommandOutput) => void)
  - - (err: any, data?: ImportCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ImportCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:360
importCertificate(args: ImportCertificateCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ImportCertificateCommandOutput) => void)): void
Parameters
- args: ImportCertificateCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ImportCertificateCommandOutput) => void)
  - - (err: any, data?: ImportCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ImportCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:364

listAgreements

listAgreements(args: ListAgreementsCommandInput, options?: HttpHandlerOptions): Promise<ListAgreementsCommandOutput>
See
ListAgreementsCommand
Parameters
- args: ListAgreementsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListAgreementsCommandOutput>
- Defined in clients/as2/src/As2.ts:373
listAgreements(args: ListAgreementsCommandInput, cb: ((err: any, data?: ListAgreementsCommandOutput) => void)): void
Parameters
- args: ListAgreementsCommandInput
- cb: ((err: any, data?: ListAgreementsCommandOutput) => void)
  - - (err: any, data?: ListAgreementsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAgreementsCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:377
listAgreements(args: ListAgreementsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListAgreementsCommandOutput) => void)): void
Parameters
- args: ListAgreementsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListAgreementsCommandOutput) => void)
  - - (err: any, data?: ListAgreementsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAgreementsCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:378

listCertificates

listCertificates(args: ListCertificatesCommandInput, options?: HttpHandlerOptions): Promise<ListCertificatesCommandOutput>
See
ListCertificatesCommand
Parameters
- args: ListCertificatesCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListCertificatesCommandOutput>
- Defined in clients/as2/src/As2.ts:387
listCertificates(args: ListCertificatesCommandInput, cb: ((err: any, data?: ListCertificatesCommandOutput) => void)): void
Parameters
- args: ListCertificatesCommandInput
- cb: ((err: any, data?: ListCertificatesCommandOutput) => void)
  - - (err: any, data?: ListCertificatesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListCertificatesCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:391
listCertificates(args: ListCertificatesCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListCertificatesCommandOutput) => void)): void
Parameters
- args: ListCertificatesCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListCertificatesCommandOutput) => void)
  - - (err: any, data?: ListCertificatesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListCertificatesCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:395

listConnectors

listConnectors(args: ListConnectorsCommandInput, options?: HttpHandlerOptions): Promise<ListConnectorsCommandOutput>
See
ListConnectorsCommand
Parameters
- args: ListConnectorsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListConnectorsCommandOutput>
- Defined in clients/as2/src/As2.ts:404
listConnectors(args: ListConnectorsCommandInput, cb: ((err: any, data?: ListConnectorsCommandOutput) => void)): void
Parameters
- args: ListConnectorsCommandInput
- cb: ((err: any, data?: ListConnectorsCommandOutput) => void)
  - - (err: any, data?: ListConnectorsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListConnectorsCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:408
listConnectors(args: ListConnectorsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListConnectorsCommandOutput) => void)): void
Parameters
- args: ListConnectorsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListConnectorsCommandOutput) => void)
  - - (err: any, data?: ListConnectorsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListConnectorsCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:409

listProfiles

listProfiles(args: ListProfilesCommandInput, options?: HttpHandlerOptions): Promise<ListProfilesCommandOutput>
See
ListProfilesCommand
Parameters
- args: ListProfilesCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListProfilesCommandOutput>
- Defined in clients/as2/src/As2.ts:418
listProfiles(args: ListProfilesCommandInput, cb: ((err: any, data?: ListProfilesCommandOutput) => void)): void
Parameters
- args: ListProfilesCommandInput
- cb: ((err: any, data?: ListProfilesCommandOutput) => void)
  - - (err: any, data?: ListProfilesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListProfilesCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:419
listProfiles(args: ListProfilesCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListProfilesCommandOutput) => void)): void
Parameters
- args: ListProfilesCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListProfilesCommandOutput) => void)
  - - (err: any, data?: ListProfilesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListProfilesCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:420

listServers

listServers(args: ListServersCommandInput, options?: HttpHandlerOptions): Promise<ListServersCommandOutput>
See
ListServersCommand
Parameters
- args: ListServersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListServersCommandOutput>
- Defined in clients/as2/src/As2.ts:429
listServers(args: ListServersCommandInput, cb: ((err: any, data?: ListServersCommandOutput) => void)): void
Parameters
- args: ListServersCommandInput
- cb: ((err: any, data?: ListServersCommandOutput) => void)
  - - (err: any, data?: ListServersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListServersCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:430
listServers(args: ListServersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListServersCommandOutput) => void)): void
Parameters
- args: ListServersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListServersCommandOutput) => void)
  - - (err: any, data?: ListServersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListServersCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:431

startFileTransfer

startFileTransfer(args: StartFileTransferCommandInput, options?: HttpHandlerOptions): Promise<StartFileTransferCommandOutput>
See
StartFileTransferCommand
Parameters
- args: StartFileTransferCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<StartFileTransferCommandOutput>
- Defined in clients/as2/src/As2.ts:440
startFileTransfer(args: StartFileTransferCommandInput, cb: ((err: any, data?: StartFileTransferCommandOutput) => void)): void
Parameters
- args: StartFileTransferCommandInput
- cb: ((err: any, data?: StartFileTransferCommandOutput) => void)
  - - (err: any, data?: StartFileTransferCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: StartFileTransferCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:444
startFileTransfer(args: StartFileTransferCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: StartFileTransferCommandOutput) => void)): void
Parameters
- args: StartFileTransferCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: StartFileTransferCommandOutput) => void)
  - - (err: any, data?: StartFileTransferCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: StartFileTransferCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:448

updateAgreement

updateAgreement(args: UpdateAgreementCommandInput, options?: HttpHandlerOptions): Promise<UpdateAgreementCommandOutput>
See
UpdateAgreementCommand
Parameters
- args: UpdateAgreementCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateAgreementCommandOutput>
- Defined in clients/as2/src/As2.ts:457
updateAgreement(args: UpdateAgreementCommandInput, cb: ((err: any, data?: UpdateAgreementCommandOutput) => void)): void
Parameters
- args: UpdateAgreementCommandInput
- cb: ((err: any, data?: UpdateAgreementCommandOutput) => void)
  - - (err: any, data?: UpdateAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:461
updateAgreement(args: UpdateAgreementCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateAgreementCommandOutput) => void)): void
Parameters
- args: UpdateAgreementCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateAgreementCommandOutput) => void)
  - - (err: any, data?: UpdateAgreementCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateAgreementCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:462

updateCertificate

updateCertificate(args: UpdateCertificateCommandInput, options?: HttpHandlerOptions): Promise<UpdateCertificateCommandOutput>
See
UpdateCertificateCommand
Parameters
- args: UpdateCertificateCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateCertificateCommandOutput>
- Defined in clients/as2/src/As2.ts:471
updateCertificate(args: UpdateCertificateCommandInput, cb: ((err: any, data?: UpdateCertificateCommandOutput) => void)): void
Parameters
- args: UpdateCertificateCommandInput
- cb: ((err: any, data?: UpdateCertificateCommandOutput) => void)
  - - (err: any, data?: UpdateCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:475
updateCertificate(args: UpdateCertificateCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateCertificateCommandOutput) => void)): void
Parameters
- args: UpdateCertificateCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateCertificateCommandOutput) => void)
  - - (err: any, data?: UpdateCertificateCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateCertificateCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:479

updateConnector

updateConnector(args: UpdateConnectorCommandInput, options?: HttpHandlerOptions): Promise<UpdateConnectorCommandOutput>
See
UpdateConnectorCommand
Parameters
- args: UpdateConnectorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateConnectorCommandOutput>
- Defined in clients/as2/src/As2.ts:488
updateConnector(args: UpdateConnectorCommandInput, cb: ((err: any, data?: UpdateConnectorCommandOutput) => void)): void
Parameters
- args: UpdateConnectorCommandInput
- cb: ((err: any, data?: UpdateConnectorCommandOutput) => void)
  - - (err: any, data?: UpdateConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:492
updateConnector(args: UpdateConnectorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateConnectorCommandOutput) => void)): void
Parameters
- args: UpdateConnectorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateConnectorCommandOutput) => void)
  - - (err: any, data?: UpdateConnectorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateConnectorCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:493

updateProfile

updateProfile(args: UpdateProfileCommandInput, options?: HttpHandlerOptions): Promise<UpdateProfileCommandOutput>
See
UpdateProfileCommand
Parameters
- args: UpdateProfileCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateProfileCommandOutput>
- Defined in clients/as2/src/As2.ts:502
updateProfile(args: UpdateProfileCommandInput, cb: ((err: any, data?: UpdateProfileCommandOutput) => void)): void
Parameters
- args: UpdateProfileCommandInput
- cb: ((err: any, data?: UpdateProfileCommandOutput) => void)
  - - (err: any, data?: UpdateProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:503
updateProfile(args: UpdateProfileCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateProfileCommandOutput) => void)): void
Parameters
- args: UpdateProfileCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateProfileCommandOutput) => void)
  - - (err: any, data?: UpdateProfileCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateProfileCommandOutput
      
      Returns void
Returns void
- Defined in clients/as2/src/As2.ts:504

Class As2

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: As2ClientConfig

Returns As2

Properties

Readonly config

Methods

createAgreement

See

Parameters

args: CreateAgreementCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateAgreementCommandOutput>

Parameters

args: CreateAgreementCommandInput

cb: ((err: any, data?: CreateAgreementCommandOutput) => void)

Parameters

err: any

Optional data: CreateAgreementCommandOutput

Returns void

Returns void

Parameters

args: CreateAgreementCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateAgreementCommandOutput) => void)

Parameters

err: any

Optional data: CreateAgreementCommandOutput

Returns void

Returns void

createConnector

See

Parameters

args: CreateConnectorCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateConnectorCommandOutput>

Parameters

args: CreateConnectorCommandInput

cb: ((err: any, data?: CreateConnectorCommandOutput) => void)

Parameters

err: any

Optional data: CreateConnectorCommandOutput

Returns void

Returns void

Parameters

args: CreateConnectorCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateConnectorCommandOutput) => void)

Parameters

err: any

Optional data: CreateConnectorCommandOutput

Returns void

Returns void

createProfile

See

Parameters

args: CreateProfileCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateProfileCommandOutput>

Parameters

args: CreateProfileCommandInput

cb: ((err: any, data?: CreateProfileCommandOutput) => void)

Parameters

err: any

Optional data: CreateProfileCommandOutput

Returns void

Returns void

Parameters

args: CreateProfileCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateProfileCommandOutput) => void)

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateAgreementCommandOutput

`Optional` data: CreateAgreementCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateConnectorCommandOutput

`Optional` data: CreateConnectorCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateProfileCommandOutput

`Optional` data: CreateProfileCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateServerCommandOutput

`Optional` data: CreateServerCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteAgreementCommandOutput

`Optional` data: DeleteAgreementCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteCertificateCommandOutput