list_batch_segment_jobs `async` ¶

list_batch_segment_jobs(
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    solution_version_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListBatchSegmentJobsResponse

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

Parameters:

solution_version_arn (Optional[Arn], default: None ) –

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
next_token (Optional[NextToken], default: None ) –

The token to request the next page of results.
max_results (Optional[MaxResults], default: None ) –

The maximum number of batch segment job results to return in each page. The default value is 100.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
InvalidNextTokenException –

The token is not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_personalize/_services/async_personalize.py

async def list_batch_segment_jobs(
    self,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    solution_version_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_batch_segment_jobs_response.ListBatchSegmentJobsResponse":
    """<p>Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.</p>

    Args:
        solution_version_arn: <p>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</p>
        next_token: <p>The token to request the next page of results.</p>
        max_results: <p>The maximum number of batch segment job results to return in each page. The default value is 100.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.list_batch_segment_jobs_request.ListBatchSegmentJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.list_batch_segment_jobs_response.ListBatchSegmentJobsResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_batch_segment_jobs

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.list_batch_segment_jobs.async_list_batch_segment_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBatchSegmentJobs")
    )
    input_: capo_personalize.types.list_batch_segment_jobs_request.ListBatchSegmentJobsRequest = {}
    if solution_version_arn is not None:
        input_["solution_version_arn"] = solution_version_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_batch_segment_jobs async ¶

list_batch_segment_jobs `async` ¶