Returns a list of audience generation jobs.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The token value retrieved from a previous call to access the next page of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum size of the results that is returned per call.
-
configured_audience_model_arn
(Optional[ConfiguredAudienceModelArn], default:
None
)
–
The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.
-
collaboration_id
(Optional[UUID], default:
None
)
–
The identifier of the collaboration that contains the audience generation jobs that you are interested in.
Raises:
Source code in docs_src/capo_cleanroomsml/_services/clean_rooms_ml.py
| def list_audience_generation_jobs(
self,
*,
config_overrides: Optional[CleanRoomsMLClientConfig] = None,
next_token: Optional["capo_cleanroomsml.types.next_token.NextToken"] = None,
max_results: Optional["capo_cleanroomsml.types.max_results.MaxResults"] = None,
configured_audience_model_arn: Optional[
"capo_cleanroomsml.types.configured_audience_model_arn.ConfiguredAudienceModelArn"
] = None,
collaboration_id: Optional["capo_cleanroomsml.types.uuid.UUID"] = None,
) -> "capo_cleanroomsml.types.list_audience_generation_jobs_response.ListAudienceGenerationJobsResponse":
"""<p>Returns a list of audience generation jobs.</p>
Args:
next_token: <p>The token value retrieved from a previous call to access the next page of results.</p>
max_results: <p>The maximum size of the results that is returned per call.</p>
configured_audience_model_arn: <p>The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.</p>
collaboration_id: <p>The identifier of the collaboration that contains the audience generation jobs that you are interested in.</p>
Raises:
capo_cleanroomsml.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_cleanroomsml.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_cleanroomsml.errors.validation_exception.ValidationException: <p>The request parameters for this request are incorrect.</p>
capo_cleanroomsml.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cleanroomsml.types.list_audience_generation_jobs_request.ListAudienceGenerationJobsRequest]",
) -> OperationResponse[
"capo_cleanroomsml.types.list_audience_generation_jobs_response.ListAudienceGenerationJobsResponse"
]:
import capo_cleanroomsml._operations.aws_stark_control_service.list_audience_generation_jobs
output, http_response = (
capo_cleanroomsml._operations.aws_stark_control_service.list_audience_generation_jobs.list_audience_generation_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAudienceGenerationJobs")
)
input_: capo_cleanroomsml.types.list_audience_generation_jobs_request.ListAudienceGenerationJobsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if configured_audience_model_arn is not None:
input_["configured_audience_model_arn"] = configured_audience_model_arn
if collaboration_id is not None:
input_["collaboration_id"] = collaboration_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|