Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
Parameters:
-
solution_arn
(Optional[Arn], default:
None
)
–
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.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of campaigns to return.
Raises:
Source code in docs_src/capo_personalize/_services/personalize.py
| def list_campaigns(
self,
*,
config_overrides: Optional[PersonalizeClientConfig] = None,
solution_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_campaigns_response.ListCampaignsResponse":
"""<p>Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
Args:
solution_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: <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: <p>The maximum number of campaigns 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_campaigns_request.ListCampaignsRequest]",
) -> OperationResponse[
"capo_personalize.types.list_campaigns_response.ListCampaignsResponse"
]:
import capo_personalize._operations.amazon_personalize.list_campaigns
output, http_response = (
capo_personalize._operations.amazon_personalize.list_campaigns.list_campaigns(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCampaigns")
)
input_: capo_personalize.types.list_campaigns_request.ListCampaignsRequest = {}
if solution_arn is not None:
input_["solution_arn"] = solution_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
|