CreateProfile - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateProfile

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

Request Syntax

{ "As2Id": "string", "CertificateIds": [ "string" ], "ProfileType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

As2Id

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\p{Print}\s]*

Required: Yes

CertificateIds

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

Type: Array of strings

Length Constraints: Fixed length of 22.

Pattern: ^cert-([0-9a-f]{17})$

Required: No

ProfileType

Determines the type of profile to create:

  • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

  • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

Type: String

Valid Values: LOCAL | PARTNER

Required: Yes

Tags

Key-value pairs that can be used to group and search for AS2 profiles.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax

{ "ProfileId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProfileId

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

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^p-([0-9a-f]{17})$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AmazonTransfer Family service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AmazonTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AmazonTransfer Family service is not available.

HTTP Status Code: 500

Examples

Example

The following example creates a profile, and returns the profile ID.

The certificate IDs are created when you run import-certificate, one for the signing certificate, and one for the encryption certificate.

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb

Sample Response

The API call returns the profile ID for the new profile.

{ "ProfileId": "p-11112222333344444" }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: