Transfer / Client / create_profile

create_profile#

Transfer.Client.create_profile(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_profile(
    As2Id='string',
    ProfileType='LOCAL'|'PARTNER',
    CertificateIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • As2Id (string) –

    [REQUIRED]

    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.

  • ProfileType (string) –

    [REQUIRED]

    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.

  • CertificateIds (list) –

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

    • (string) –

  • Tags (list) –

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

    • (dict) –

      Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

      • Key (string) – [REQUIRED]

        The name assigned to the tag that you create.

      • Value (string) – [REQUIRED]

        Contains one or more values that you assigned to the key name you create.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileId': 'string'
}

Response Structure

  • (dict) –

    • ProfileId (string) –

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

Exceptions

  • Transfer.Client.exceptions.ResourceNotFoundException

  • Transfer.Client.exceptions.InvalidRequestException

  • Transfer.Client.exceptions.ThrottlingException

  • Transfer.Client.exceptions.InternalServiceError

  • Transfer.Client.exceptions.ServiceUnavailableException