Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRelationship

Creates a new partner relationship between accounts.

Request Syntax


{
   "associatedAccountId": "string",
   "associationType": "string",
   "catalog": "string",
   "clientToken": "string",
   "displayName": "string",
   "programManagementAccountIdentifier": "string",
   "requestedSupportPlan": { ... },
   "resaleAccountModel": "string",
   "sector": "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.

Note

In the following list, the required parameters are described first.

associatedAccountId

The AWS account ID to associate in this relationship.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]*

Required: Yes

associationType

The type of association for the relationship (e.g., reseller, distributor).

Type: String

Valid Values: DOWNSTREAM_SELLER | END_CUSTOMER | INTERNAL

Required: Yes

catalog

The catalog identifier for the relationship.

Type: String

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

Pattern: [a-zA-Z]*

Required: Yes

displayName

A human-readable name for the relationship.

Type: String

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

Pattern: [^\x00-\x1F\x7F]*

Required: Yes

programManagementAccountIdentifier

The identifier of the program management account for this relationship.

Type: String

Length Constraints: Minimum length of 17. Maximum length of 1011.

Pattern: (arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}

Required: Yes

sector

The business sector for the relationship.

Type: String

Valid Values: COMMERCIAL | GOVERNMENT | GOVERNMENT_EXCEPTION

Required: Yes

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

Type: String

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

Pattern: [!-~]*

Required: No

requestedSupportPlan

The support plan requested for this relationship.

Type: SupportPlan object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

resaleAccountModel

The resale account model for the relationship.

Type: String

Valid Values: DISTRIBUTOR | END_CUSTOMER | SOLUTION_PROVIDER

Required: No

tags

Key-value pairs to associate with the relationship.

Type: Array of Tag objects

Required: No

Response Syntax


{
   "relationshipDetail": { 
      "arn": "string",
      "id": "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.

relationshipDetail

Details of the created relationship.

Type: CreateRelationshipDetail object

Errors

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

AccessDeniedException

The request was denied due to insufficient permissions.

message: A message describing the access denial.
reason: The reason for the access denial.

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

message: A message describing the conflict.
resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of the resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request.

message: A message describing the internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

message: A message describing the resource not found error.
resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 400

ServiceQuotaExceededException

The request would exceed a service quota limit.

message: A message describing the service quota exceeded error.
quotaCode: The code identifying the specific quota that would be exceeded.
resourceId: The identifier of the resource that would exceed the quota.
resourceType: The type of the resource that would exceed the quota.

HTTP Status Code: 400

ThrottlingException

The request was throttled due to too many requests being sent in a short period.

message: A message describing the throttling error.
quotaCode: The quota code associated with the throttling error.
serviceCode: The service code associated with the throttling error.

HTTP Status Code: 400

ValidationException

The request failed validation due to invalid input parameters.

fieldList: A list of fields that failed validation.
message: A message describing the validation error.
reason: The reason for the validation failure.

HTTP Status Code: 400