Lists all of the export jobs.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The pagination token returned from a previous call to ListExportJobs to indicate the position in the list of export jobs.
-
page_size
(Optional[MaxItems], default:
None
)
–
Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent calls to ListExportJobs to retrieve additional export jobs.
-
export_source_type
(Optional[ExportSourceType], default:
None
)
–
A value used to list export jobs that have a certain ExportSourceType.
-
job_status
(Optional[JobStatus], default:
None
)
–
A value used to list export jobs that have a certain JobStatus.
Raises:
Source code in docs_src/capo_sesv2/_services/se_sv2.py
| def list_export_jobs(
self,
*,
config_overrides: Optional[SESv2ClientConfig] = None,
next_token: Optional["capo_sesv2.types.next_token.NextToken"] = None,
page_size: Optional["capo_sesv2.types.max_items.MaxItems"] = None,
export_source_type: Optional[
"capo_sesv2.types.export_source_type.ExportSourceType"
] = None,
job_status: Optional["capo_sesv2.types.job_status.JobStatus"] = None,
) -> "capo_sesv2.types.list_export_jobs_response.ListExportJobsResponse":
"""<p>Lists all of the export jobs.</p>
Args:
next_token: <p>The pagination token returned from a previous call to <code>ListExportJobs</code> to indicate the position in the list of export jobs.</p>
page_size: <p>Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> value in subsequent calls to <code>ListExportJobs</code> to retrieve additional export jobs.</p>
export_source_type: <p>A value used to list export jobs that have a certain <code>ExportSourceType</code>.</p>
job_status: <p>A value used to list export jobs that have a certain <code>JobStatus</code>.</p>
Raises:
capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_sesv2.types.list_export_jobs_request.ListExportJobsRequest]",
) -> OperationResponse[
"capo_sesv2.types.list_export_jobs_response.ListExportJobsResponse"
]:
import capo_sesv2._operations.simple_email_service_v2.list_export_jobs
output, http_response = (
capo_sesv2._operations.simple_email_service_v2.list_export_jobs.list_export_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListExportJobs")
)
input_: capo_sesv2.types.list_export_jobs_request.ListExportJobsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if page_size is not None:
input_["page_size"] = page_size
if export_source_type is not None:
input_["export_source_type"] = export_source_type
if job_status is not None:
input_["job_status"] = job_status
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|