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.

Request Syntax

response = client.create_partnership(
    profileId='string',
    name='string',
    email='string',
    phone='string',
    capabilities=[
        'string',
    ],
    capabilityOptions={
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False
                }
            }
        }
    },
    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) –
[REQUIRED]

Specifies a list of the capabilities associated with this partnership.
- (string) –
capabilityOptions (dict) –
Specify the structure that contains the details for the associated capabilities.
- outboundEdi (dict) –
  
  A structure that contains the outbound EDI options.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: x12.
  - x12 (dict) –
    
    A structure that contains an X12 envelope structure.
    - common (dict) –
      
      A container for the X12 outbound EDI headers.
      - interchangeControlHeaders (dict) –
        
        In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
        
        senderIdQualifier (string) –
        
        Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
        
        senderId (string) –
        
        Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
        
        receiverIdQualifier (string) –
        
        Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
        
        receiverId (string) –
        
        Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
        
        repetitionSeparator (string) –
        
        Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
        
        Note
        This parameter is only honored for version greater than 401 ( VERSION_4010 and higher).
        
        For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.
        
        acknowledgmentRequestedCode (string) –
        
        Located at position ISA-14 in the header. The value “1” indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value “0” is used otherwise.
        
        usageIndicatorCode (string) –
        
        Located at position ISA-15 in the header. Specifies how this interchange is being used:
        
        T indicates this interchange is for testing.
        
        P indicates this interchange is for production.
        
        I indicates this interchange is informational.
      - functionalGroupHeaders (dict) –
        
        The functional group headers for the X12 object.
        
        applicationSenderCode (string) –
        
        A value representing the code used to identify the party transmitting a message, at position GS-02.
        
        applicationReceiverCode (string) –
        
        A value representing the code used to identify the party receiving a message, at position GS-03.
        
        responsibleAgencyCode (string) –
        
        A code that identifies the issuer of the standard, at position GS-07.
      - delimiters (dict) –
        
        The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
        
        componentSeparator (string) –
        
        The component, or sub-element, separator. The default value is : (colon).
        
        dataElementSeparator (string) –
        
        The data element separator. The default value is * (asterisk).
        
        segmentTerminator (string) –
        
        The segment terminator. The default value is ~ (tilde).
      - validateEdi (boolean) –
        
        Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
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',
    ],
    'capabilityOptions': {
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False
                }
            }
        }
    },
    '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) –
- capabilityOptions (dict) –
  
  Returns the structure that contains the details for the associated capabilities.
  - outboundEdi (dict) –
    
    A structure that contains the outbound EDI options.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: x12. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - x12 (dict) –
      
      A structure that contains an X12 envelope structure.
      - common (dict) –
        
        A container for the X12 outbound EDI headers.
        
        interchangeControlHeaders (dict) –
        
        In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
        
        senderIdQualifier (string) –
        
        Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
        
        senderId (string) –
        
        Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
        
        receiverIdQualifier (string) –
        
        Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
        
        receiverId (string) –
        
        Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
        
        repetitionSeparator (string) –
        
        Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
        
        Note
        This parameter is only honored for version greater than 401 ( VERSION_4010 and higher).
        
        For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.
        
        acknowledgmentRequestedCode (string) –
        
        Located at position ISA-14 in the header. The value “1” indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value “0” is used otherwise.
        
        usageIndicatorCode (string) –
        
        Located at position ISA-15 in the header. Specifies how this interchange is being used:
        
        T indicates this interchange is for testing.
        
        P indicates this interchange is for production.
        
        I indicates this interchange is informational.
        
        functionalGroupHeaders (dict) –
        
        The functional group headers for the X12 object.
        
        applicationSenderCode (string) –
        
        A value representing the code used to identify the party transmitting a message, at position GS-02.
        
        applicationReceiverCode (string) –
        
        A value representing the code used to identify the party receiving a message, at position GS-03.
        
        responsibleAgencyCode (string) –
        
        A code that identifies the issuer of the standard, at position GS-07.
        
        delimiters (dict) –
        
        The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
        
        componentSeparator (string) –
        
        The component, or sub-element, separator. The default value is : (colon).
        
        dataElementSeparator (string) –
        
        The data element separator. The default value is * (asterisk).
        
        segmentTerminator (string) –
        
        The segment terminator. The default value is ~ (tilde).
        
        validateEdi (boolean) –
        
        Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
- 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

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