Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458293303.1 KB

Creates the local or partner profile to use for AS2 transfers.

post/#X-Amz-Target=TransferService.CreateProfile

Headers

X-Amz-Target'TransferService.CreateProfile' required

Request body

As2Idstring required

The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.

ProfileType'LOCAL' | 'PARTNER' required
<p>Determines the type of profile to create:</p> <ul> <li> <p>Specify <code>LOCAL</code> to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.</p> </li> <li> <p>Specify <code>PARTNER</code> to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.</p> </li> </ul>
CertificateIdsCertificateId[]

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Response

Success

ProfileIdstring required

The unique identifier for the AS2 profile, returned after the API call succeeds.