B2BI / Client / update_partnership

update_partnership#

B2BI.Client.update_partnership(**kwargs)#

Updates some of the parameters for a partnership between a customer and trading partner. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

See also: AWS API Documentation

Request Syntax

response = client.update_partnership(
    partnershipId='string',
    name='string',
    capabilities=[
        'string',
    ]
)
Parameters:

  • partnershipId (string) –

    [REQUIRED]

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

  • name (string) – The name of the partnership, used to identify it.

  • capabilities (list) –

    List of the capabilities associated with this partnership.

    • (string) –

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),
    'modifiedAt': 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) –

      The name of the partnership, used to identify it.

    • 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 that identifies the most recent date and time that the partnership was modified.

    • modifiedAt (datetime) –

      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

Exceptions

  • B2BI.Client.exceptions.ConflictException

  • B2BI.Client.exceptions.AccessDeniedException

  • B2BI.Client.exceptions.ValidationException

  • B2BI.Client.exceptions.ThrottlingException

  • B2BI.Client.exceptions.ResourceNotFoundException

  • B2BI.Client.exceptions.ServiceQuotaExceededException

  • B2BI.Client.exceptions.InternalServerException