B2BI / Client / get_partnership

get_partnership#

B2BI.Client.get_partnership(**kwargs)#

Retrieves the details for a partnership, based on the partner and profile IDs specified. 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.get_partnership(
    partnershipId='string'
)
Parameters:

partnershipId (string) –

[REQUIRED]

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

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) –

      Returns the display name of 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 identifier for the partner for this partnership.

    • createdAt (datetime) –

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

    • modifiedAt (datetime) –

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

Exceptions

  • B2BI.Client.exceptions.AccessDeniedException

  • B2BI.Client.exceptions.ValidationException

  • B2BI.Client.exceptions.ThrottlingException

  • B2BI.Client.exceptions.ResourceNotFoundException

  • B2BI.Client.exceptions.InternalServerException