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

UpdatePartnership

Updates some of the parameters for a partnership between a customer and trading partner. 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": { 
      "inboundEdi": { 
         "x12": { 
            "acknowledgmentOptions": { 
               "functionalAcknowledgment": "string",
               "technicalAcknowledgment": "string"
            }
         }
      },
      "outboundEdi": { ... }
   },
   "name": "string",
   "partnershipId": "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

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: No

capabilityOptions

To update, specify the structure that contains the details for the associated capabilities.

Type: CapabilityOptions object

Required: No

name

The name of the partnership, used to identify it.

Type: String

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

Required: No

partnershipId

Specifies 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_-]+

Required: Yes

Response Syntax

{
   "capabilities": [ "string" ],
   "capabilityOptions": { 
      "inboundEdi": { 
         "x12": { 
            "acknowledgmentOptions": { 
               "functionalAcknowledgment": "string",
               "technicalAcknowledgment": "string"
            }
         }
      },
      "outboundEdi": { ... }
   },
   "createdAt": "string",
   "email": "string",
   "modifiedAt": "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 that identifies the most recent date and time that the partnership was modified.

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\.\-]+

modifiedAt

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

Type: Timestamp

name

The name of the partnership, used to identify it.

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.

retryAfterSeconds

The server attempts to retry a failed command.

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.

quotaCode

The quota that was exceeded, which caused the exception.

resourceId

The ID for the resource that exceeded the quota, which caused the exception.

resourceType

The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.

serviceCode

The code responsible for exceeding the quota, which caused the exception.

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.

retryAfterSeconds

The server attempts to retry a command that was throttled.

HTTP Status Code: 400

ValidationException

When you use Transformer APIs, TestConversion, or TestParsing, the service throws a validation exception if a rule is configured incorrectly. For example, a validation exception occurs when:

  • A rule references an element that doesn't exist in the selected transaction set

  • An element length rule specifies a minimum length less than 0

Note

If your custom validation rules are configured correctly but the EDI validation fails due to those rules, this is expected behavior and doesn't result in a ValidationException.

For all other API operations, a validation exception occurs when a Trading Partner object can't be validated against a request from another object. This can happen during:

  • Standard EDI validation

  • Custom validation rule evaluation, such as when:

    • Element lengths don't meet specified constraints

    • Code list validations contain invalid codes

    • Required elements are missing based on your element requirement rules

HTTP Status Code: 400

Examples

Example

The following example updates a partnership.

Sample Request

{
    "capabilities": [
        "ca-1111aaaa2222bbbb3"
    ],
    "name": "b2bipartner",
    "partnershipId": "ps-5555zzzz4444yyyyy"
}

Sample Response

{
    "capabilities": [
        "ca-1111aaaa2222bbbb3"
    ],
    "createdAt": "2023-11-01T21:51:05.504Z",
    "email": "john@example.com",
    "modifiedAt": "2023-11-01T21:51:05.504Z",
    "name": "b2bipartner",
    "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-5555zzzz4444yyyyy",
    "partnershipId": "ps-5555zzzz4444yyyyy",
    "phone": "5555555555",
    "profileId": "p-ABCDE111122223333",
    "tradingPartnerId": "tp-11112222333344445"
}

See Also

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