Skip to content

list_solutions

list_solutions(
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
    dataset_group_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListSolutionsResponse

Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Parameters:

  • dataset_group_arn (Optional[Arn], default: None ) –

    The Amazon Resource Name (ARN) of the dataset group.

  • next_token (Optional[NextToken], default: None ) –

    A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of solutions to return.

Raises:

Source code in docs_src/capo_personalize/_services/personalize.py
def list_solutions(
    self,
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
    dataset_group_arn: Optional["capo_personalize.types.arn.Arn"] = None,
    next_token: Optional["capo_personalize.types.next_token.NextToken"] = None,
    max_results: Optional["capo_personalize.types.max_results.MaxResults"] = None,
) -> "capo_personalize.types.list_solutions_response.ListSolutionsResponse":
    """<p>Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>

    Args:
        dataset_group_arn: <p>The Amazon Resource Name (ARN) of the dataset group.</p>
        next_token: <p>A token returned from the previous call to <code>ListSolutions</code> for getting the next set of solutions (if they exist).</p>
        max_results: <p>The maximum number of solutions to return.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_personalize.types.list_solutions_request.ListSolutionsRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.list_solutions_response.ListSolutionsResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_solutions

        output, http_response = (
            capo_personalize._operations.amazon_personalize.list_solutions.list_solutions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSolutions")
    )
    input_: capo_personalize.types.list_solutions_request.ListSolutionsRequest = {}
    if dataset_group_arn is not None:
        input_["dataset_group_arn"] = dataset_group_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output