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.
Request Syntax
{
"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.
- 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": {
"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
-
Contains the details for an Outbound EDI capability.
Type: CapabilityOptions object
- createdAt
-
Returns a timestamp for creation date and time of the partnership.
Type: Timestamp
-
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
-
Returns the display name of 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 identifier for the partner for this partnership.
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
- 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 retrieves details for the specified partnership.
Sample Request
{
"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:
