Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateAwsAccountWithPartnerAccount

Associates a partner account with your AWS account.

Request Syntax


POST /partner-accounts HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Sidewalk": { 
      "AmazonId": "string",
      "AppServerPrivateKey": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

Type: String

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

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

Required: No

Sidewalk

The Sidewalk account credentials.

Type: SidewalkAccountInfo object

Required: Yes

Tags

The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Type: Array of Tag objects

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Sidewalk": { 
      "AmazonId": "string",
      "AppServerPrivateKey": "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.

Arn

The Amazon Resource Name of the resource.

Type: String

Sidewalk

The Sidewalk account credentials.

Type: SidewalkAccountInfo object

Errors

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

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

ResourceId: Id of the resource in the conflicting operation.
ResourceType: Type of the resource in the conflicting operation.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

ResourceId: Id of the not found resource.
ResourceType: Type of the font found resource.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400