get_batch_prediction_jobs ¶

get_batch_prediction_jobs(
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    job_id: Optional[identifier] = None,
    max_results: Optional[batchPredictionsMaxPageSize] = None,
    next_token: Optional[string] = None,
) -> GetBatchPredictionJobsResult

Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

Parameters:

job_id (Optional[identifier], default: None ) –

The batch prediction job for which to get the details.
max_results (Optional[batchPredictionsMaxPageSize], default: None ) –

The maximum number of objects to return for the request.
next_token (Optional[string], default: None ) –

The next token from the previous request.

Raises:

AccessDeniedException –

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.
InternalServerException –

An exception indicating an internal server error.
ResourceNotFoundException –

An exception indicating the specified resource was not found.
ThrottlingException –

An exception indicating a throttling error.
ValidationException –

An exception indicating a specified value is not allowed.
UnknownServiceError –

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

Source code in docs_src/capo_frauddetector/_services/fraud_detector.py

def get_batch_prediction_jobs(
    self,
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    job_id: Optional["capo_frauddetector.types.identifier.identifier"] = None,
    max_results: Optional[
        "capo_frauddetector.types.batch_predictions_max_page_size.batchPredictionsMaxPageSize"
    ] = None,
    next_token: Optional["capo_frauddetector.types.string.string"] = None,
) -> "capo_frauddetector.types.get_batch_prediction_jobs_result.GetBatchPredictionJobsResult":
    """<p>Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.</p>

    Args:
        job_id: <p>The batch prediction job for which to get the details.</p>
        max_results: <p>The maximum number of objects to return for the request.</p>
        next_token: <p>The next token from the previous request.</p>

    Raises:
        capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
        capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
        capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
        capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
        capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
        capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_frauddetector.types.get_batch_prediction_jobs_request.GetBatchPredictionJobsRequest]",
    ) -> OperationResponse[
        "capo_frauddetector.types.get_batch_prediction_jobs_result.GetBatchPredictionJobsResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_batch_prediction_jobs

        output, http_response = (
            capo_frauddetector._operations.aws_hawks_nest_service_facade.get_batch_prediction_jobs.get_batch_prediction_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBatchPredictionJobs")
    )
    input_: capo_frauddetector.types.get_batch_prediction_jobs_request.GetBatchPredictionJobsRequest = {}
    if job_id is not None:
        input_["job_id"] = job_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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