Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSolutions

Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.

Request Syntax


{
   "Catalog": "string",
   "Category": [ "string" ],
   "Identifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "Status": [ "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

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the AWS catalog, and Sandbox to list solutions in a secure and isolated testing environment.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

Category

Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

Type: Array of strings

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

Required: No

Identifier

Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

Type: Array of strings

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

Pattern: ^S-[0-9]{1,19}$

Required: No

MaxResults

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

Type: String

Required: No

Sort

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

Type: SolutionSort object

Required: No

Status

Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.

Type: Array of strings

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

Valid Values: Active | Inactive | Draft

Required: No

Response Syntax


{
   "NextToken": "string",
   "SolutionSummaries": [ 
      { 
         "Catalog": "string",
         "Category": "string",
         "CreatedDate": "string",
         "Id": "string",
         "Name": "string",
         "Status": "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.

SolutionSummaries

An array with minimal details for solutions matching the request criteria.

Type: Array of SolutionBase objects

NextToken

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

Type: String

Errors

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

AccessDeniedException

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

InternalServerException

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

HTTP Status Code: 500

ResourceNotFoundException

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400