Gets all batch import jobs or a specific job of the specified 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 GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameters:
Raises:
Source code in docs_src/capo_frauddetector/_services/fraud_detector.py
| def get_batch_import_jobs(
self,
*,
config_overrides: Optional[FraudDetectorClientConfig] = None,
job_id: Optional["capo_frauddetector.types.identifier.identifier"] = None,
max_results: Optional[
"capo_frauddetector.types.batch_imports_max_page_size.batchImportsMaxPageSize"
] = None,
next_token: Optional["capo_frauddetector.types.string.string"] = None,
) -> (
"capo_frauddetector.types.get_batch_import_jobs_result.GetBatchImportJobsResult"
):
"""<p>Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves a maximum of 50 records per page. If you provide a <code>maxResults</code>, the value must be between 1 and 50. To get the next page results, provide the pagination token from the <code>GetBatchImportJobsResponse</code> as part of your request. A null pagination token fetches the records from the beginning.</p>
Args:
job_id: <p>The ID of the batch import job to get.</p>
max_results: <p>The maximum number of objects to return for 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_import_jobs_request.GetBatchImportJobsRequest]",
) -> OperationResponse[
"capo_frauddetector.types.get_batch_import_jobs_result.GetBatchImportJobsResult"
]:
import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_batch_import_jobs
output, http_response = (
capo_frauddetector._operations.aws_hawks_nest_service_facade.get_batch_import_jobs.get_batch_import_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetBatchImportJobs")
)
input_: capo_frauddetector.types.get_batch_import_jobs_request.GetBatchImportJobsRequest = {}
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
|