PartnerCentralSellingAPI / Paginator / ListSolutions

ListSolutions#

class PartnerCentralSellingAPI.Paginator.ListSolutions#
paginator = client.get_paginator('list_solutions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from PartnerCentralSellingAPI.Client.list_solutions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    Category=[
        'string',
    ],
    Identifier=[
        'string',
    ],
    Sort={
        'SortBy': 'Identifier'|'Name'|'Status'|'Category'|'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    Status=[
        'Active'|'Inactive'|'Draft',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Catalog (string) –

    [REQUIRED]

    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 Amazon Web Services catalog, and Sandbox 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, or Managed 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) –

  • Sort (dict) –

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

    • SortBy (string) – [REQUIRED]

      Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

    • SortOrder (string) – [REQUIRED]

      Specifies the sorting order, either Ascending or Descending. The default is Descending.

  • Status (list) –

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

    • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SolutionSummaries': [
        {
            'Catalog': 'string',
            'Category': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Id': 'string',
            'Name': 'string',
            'Status': 'Active'|'Inactive'|'Draft'
        },
    ]
}

Response Structure

  • (dict) –

    • 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 or Sandbox. 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 for Active solutions for association to an opportunity.