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

GetPartnerAccount

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

Request Syntax


GET /partner-accounts/PartnerAccountId?partnerType=PartnerType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

PartnerAccountId

The partner account ID to disassociate from the AWS account.

Length Constraints: Maximum length of 256.

Required: Yes

PartnerType

The partner type.

Valid Values: Sidewalk

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

AccountLinked

Whether the partner account is linked to the AWS account.

Type: Boolean

Sidewalk

The Sidewalk account credentials.

Type: SidewalkAccountInfoWithFingerprint object

Errors

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

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

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