CreatePartnership - AWS B2B Data Interchange
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also

CreatePartnership

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

{
   "capabilities": [ "string" ],
   "capabilityOptions": { 
      "outboundEdi": { ... }
   },
   "clientToken": "string",
   "email": "string",
   "name": "string",
   "phone": "string",
   "profileId": "string",
   "tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

capabilities

Specifies a list of the capabilities associated with this partnership.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

capabilityOptions

Specify the structure that contains the details for the associated capabilities.

Type: CapabilityOptions object

Required: No

clientToken

Reserved for future use.

Type: String

Required: No

email

Specifies the email address associated with this trading partner.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 254.

Pattern: [\w\.\-]+@[\w\.\-]+

Required: Yes

name

Specifies a descriptive name for the partnership.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

Required: Yes

phone

Specifies the phone number associated with the partnership.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 22.

Pattern: \+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?

Required: No

profileId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

tags

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.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

{
   "capabilities": [ "string" ],
   "capabilityOptions": { 
      "outboundEdi": { ... }
   },
   "createdAt": "string",
   "email": "string",
   "name": "string",
   "partnershipArn": "string",
   "partnershipId": "string",
   "phone": "string",
   "profileId": "string",
   "tradingPartnerId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

capabilities

Returns one or more capabilities associated with this partnership.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

capabilityOptions

Returns the structure that contains the details for the associated capabilities.

Type: CapabilityOptions object

createdAt

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

Type: Timestamp

email

Returns the email address associated with this trading partner.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 254.

Pattern: [\w\.\-]+@[\w\.\-]+

name

Returns a descriptive name for the partnership.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

partnershipArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

partnershipId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

phone

Returns the phone number associated with the partnership.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 22.

Pattern: \+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?

profileId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

tradingPartnerId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

HTTP Status Code: 400

InternalServerException

This exception is thrown when an error occurs in the AWS B2B Data Interchange service.

HTTP Status Code: 500

ResourceNotFoundException

Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.

HTTP Status Code: 400

ServiceQuotaExceededException

Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.

HTTP Status Code: 400

ThrottlingException

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

HTTP Status Code: 400

ValidationException

Occurs when a B2BI object cannot be validated against a request from another object.

HTTP Status Code: 400

Examples

Example

The following example creates a partnership. In the command, replace the parameters with your actual values for the new partnership.

The API call returns the details for you new partnership.

//Listing for createNewPartnership.txt
{
    "profileId": "p-ABCDE111122223333",
    "name": "John Smith",
    "email": "johns@example.com",
    "phone": "5555555555",
    "capabilities": [
         "ca-1111aaaa2222bbbb3"
    ],
    "capabilityOptions": {
        "outboundEdi": {
            "x12": {
                "common": {                    
                    "delimiters": {
                        "componentSeparator": ":",
                        "dataElementSeparator": ";",
                        "replacementCharacterSeparator": ",",
                        "segmentTerminator": "/"
                    },
                    "ediValidate": true
                }
            }
        }
    },
    "clientToken": "foo",
    "tags": [
        {
            "Key": "Test",
            "Value": "True"
        }
    ]
}

Sample Request

aws b2bi create-partnership --cli-input-json file://createNewPartnership.txt

Sample Response

{
    "profileId": "p-ABCDE111122223333",
    "partnershipId": "ps-7444460000cccc1111",
    "partnershipArn": "arn:aws:b2bi:us-east-1:500655546075:partnership/ps-444460000cccc1111",
    "name": "John Smith",
    "email": "johns@example.com",
    "phone": "5555555555",
    "capabilities": [
        "ca-1111aaaa2222bbbb3"
    ],
    "capabilityOptions": {
        "outboundEdi": {
            "x12": {
                "common": {
                    "delimiters": {
                        "componentSeparator": ":",
                        "dataElementSeparator": ";",
                        "segmentTerminator": "/"
                    }
                }
            }
        }
    },
    "tradingPartnerId": tp-1234abcd5678efghj",
    "createdAt": "2024-10-15T17:27:20.972Z"
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: