Skip to content

ListCampaignsRequest

Source code in docs_src/capo_personalize/types/list_campaigns_request.py
class ListCampaignsRequest(TypedDict, closed=True):
    solution_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.</p>"""
    next_token: NotRequired["capo_personalize.types.next_token.NextToken"]
    """<p>A token returned from the previous call to <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> for getting the next set of campaigns (if they exist).</p>"""
    max_results: NotRequired["capo_personalize.types.max_results.MaxResults"]
    """<p>The maximum number of campaigns to return.</p>"""

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of campaigns to return.

next_token instance-attribute

next_token: NotRequired[NextToken]

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

solution_arn instance-attribute

solution_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.