PartnerCentralSellingAPI / Client / list_solutions
list_solutions#
- PartnerCentralSellingAPI.Client.list_solutions(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.list_solutions( Catalog='string', Category=[ 'string', ], Identifier=[ 'string', ], MaxResults=123, NextToken='string', Sort={ 'SortBy': 'Identifier'|'Name'|'Status'|'Category'|'CreatedDate', 'SortOrder': 'ASCENDING'|'DESCENDING' }, Status=[ 'Active'|'Inactive'|'Draft', ] )
- Parameters:
Catalog (string) –
[REQUIRED]
Specifies the catalog associated with the request. This field takes a string value from a predefined list:
AWS
orSandbox
. The catalog determines which environment the solutions are listed in. UseAWS
to list solutions in the Amazon Web Services catalog, andSandbox
to list solutions in a secure and isolated testing environment.Category (list) –
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
, orManaged Services
.(string) –
Identifier (list) –
Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution’s identifier for accurate results.
(string) –
MaxResults (integer) –
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
NextToken (string) – 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.
Sort (dict) –
Object that configures sorting done on the response. Default
Sort.SortBy
isIdentifier
.SortBy (string) – [REQUIRED]
Specifies the attribute to sort by, such as
Name
,CreatedDate
, orStatus
.SortOrder (string) – [REQUIRED]
Specifies the sorting order, either
Ascending
orDescending
. The default isDescending
.
Status (list) –
Filters the solutions based on their status. This filter helps retrieve solutions with statuses such as
Active
,Inactive
, orPending Approval
, allowing partners to manage their solution portfolios effectively.(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'SolutionSummaries': [ { 'Catalog': 'string', 'Category': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Id': 'string', 'Name': 'string', 'Status': 'Active'|'Inactive'|'Draft' }, ] }
Response Structure
(dict) –
NextToken (string) –
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.
SolutionSummaries (list) –
An array with minimal details for solutions matching the request criteria.
(dict) –
Specifies minimal information for the solution offered to solve the customer’s business problem.
Catalog (string) –
Specifies the catalog in which the solution is hosted, either
AWS
orSandbox
. This helps partners differentiate between live solutions and those in testing environments.Category (string) –
Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values:
Software Product
|Consulting Service
|Hardware Product
|Communications Product
|Professional Service
|Managed Service
|Value-Added Resale Amazon Web Services Service
|Distribution Service
|Training Service
|Merger and Acquisition Advising Service
.CreatedDate (datetime) –
Indicates the solution creation date. This is useful to track and audit.
Id (string) –
Enables the association of solutions (offerings) to opportunities.
Name (string) –
Specifies the solution name.
Status (string) –
Specifies the solution’s current status, which indicates its state in the system. Valid values:
Active
|Inactive
|Draft
. The status helps partners and Amazon Web Services track the solution’s lifecycle and availability. Filter forActive
solutions for association to an opportunity.
Exceptions
PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException
PartnerCentralSellingAPI.Client.exceptions.InternalServerException
PartnerCentralSellingAPI.Client.exceptions.ValidationException
PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException