B2BI / Client / create_partnership

create_partnership#

B2BI.Client.create_partnership(**kwargs)#

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

response = client.create_partnership(
    profileId='string',
    name='string',
    email='string',
    phone='string',
    capabilities=[
        'string',
    ],
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • profileId (string) –

    [REQUIRED]

    Specifies the unique, system-generated identifier for the profile connected to this partnership.

  • name (string) –

    [REQUIRED]

    Specifies a descriptive name for the partnership.

  • email (string) –

    [REQUIRED]

    Specifies the email address associated with this trading partner.

  • phone (string) – Specifies the phone number associated with the partnership.

  • capabilities (list) –

    Specifies a list of the capabilities associated with this partnership.

    • (string) –

  • clientToken (string) –

    Reserved for future use.

    This field is autopopulated if not provided.

  • tags (list) –

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    • (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 capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

      • Key (string) – [REQUIRED]

        Specifies the name assigned to the tag that you create.

      • Value (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'profileId': 'string',
    'partnershipId': 'string',
    'partnershipArn': 'string',
    'name': 'string',
    'email': 'string',
    'phone': 'string',
    'capabilities': [
        'string',
    ],
    'tradingPartnerId': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • profileId (string) –

      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • partnershipId (string) –

      Returns the unique, system-generated identifier for a partnership.

    • partnershipArn (string) –

      Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

    • name (string) –

      Returns a descriptive name for the partnership.

    • email (string) –

      Returns the email address associated with this trading partner.

    • phone (string) –

      Returns the phone number associated with the partnership.

    • capabilities (list) –

      Returns one or more capabilities associated with this partnership.

      • (string) –

    • tradingPartnerId (string) –

      Returns the unique, system-generated identifier for a trading partner.

    • createdAt (datetime) –

      Returns a timestamp for creation date and time of the partnership.

Exceptions