Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPartners

Lists partner accounts in the catalog, providing a summary view of all partners.

Request Syntax


{
   "Catalog": "string",
   "NextToken": "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.

Catalog

The catalog identifier to list partners from.

Type: String

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

Pattern: [a-zA-Z0-9-]+

Required: Yes

NextToken

The token for retrieving the next page of results in paginated responses.

Type: String

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

Pattern: [\S]+

Required: No

Response Syntax


{
   "NextToken": "string",
   "PartnerSummaryList": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "CreatedAt": "string",
         "Id": "string",
         "LegalName": "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.

PartnerSummaryList

A list of partner summaries including basic information about each partner account.

Type: Array of PartnerSummary objects

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

NextToken

The token for retrieving the next page of results if more results are available.

Type: String

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

Pattern: [\S]+

Errors

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

AccessDeniedException

The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

Reason: The specific reason for the access denial.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

HTTP Status Code: 500

ThrottlingException

The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

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. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

ErrorDetails: A list of detailed validation errors that occurred during request processing.
Reason: The reason for the validation failure.

HTTP Status Code: 400