Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListPartnerships

Lists the partnerships associated with your AWS account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "profileId": "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.

maxResults

Specifies the maximum number of capabilities to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Type: String

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

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

Response Syntax


{
   "nextToken": "string",
   "partnerships": [ 
      { 
         "capabilities": [ "string" ],
         "capabilityOptions": { 
            "outboundEdi": { ... }
         },
         "createdAt": "string",
         "modifiedAt": "string",
         "name": "string",
         "partnershipId": "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.

nextToken

Type: String

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

partnerships

Specifies a list of your partnerships.

Type: Array of PartnershipSummary objects

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

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

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 returns details for the partnerships for the specified profile. Note that in this example, there is only one partnership listed: however, this call would return up to 50 partnerships.

Sample Request


{
    "maxResults": 50,
    "nextToken": "foo",
    "profileId": "p-ABCDE111122223333"
}

Sample Response


{
    "nextToken": "string",
    "partnerships": [
        {
            "capabilities": [
                "ca-1111aaaa2222bbbb3"
            ],
            "createdAt": "2023-11-01T21:51:05.504Z",
            "modifiedAt": "2023-11-01T21:51:05.504Z",
            "name": "b2bipartner",
            "partnershipId": "ps-5555zzzz4444yyyyy",
            "profileId": "p-ABCDE111122223333",
            "tradingPartnerId": "tp-1234abcd5678efghj"
        }
    ]
}