Lists data transformation jobs for your Amazon Web Services account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.
-
next_token
(Optional[DataTransformationNextToken], default:
None
)
–
The pagination token from a previous response. Pass this value to retrieve the next page of results.
-
job_status
(Optional[TransformationJobStatus], default:
None
)
–
Filters the results to include only jobs with the specified status.
-
job_name
(Optional[DataTransformationJobName], default:
None
)
–
Filters the results to include only jobs with the specified name.
-
submitted_after
(Optional[DateTime], default:
None
)
–
Filters the results to include only jobs submitted at or after this timestamp.
-
submitted_before
(Optional[DateTime], default:
None
)
–
Filters the results to include only jobs submitted at or before this timestamp.
Raises:
Source code in docs_src/capo_healthlake/_services/health_lake.py
| def list_data_transformation_jobs(
self,
*,
config_overrides: Optional[HealthLakeClientConfig] = None,
max_results: Optional["capo_healthlake.types.max_results.MaxResults"] = None,
next_token: Optional[
"capo_healthlake.types.data_transformation_next_token.DataTransformationNextToken"
] = None,
job_status: Optional[
"capo_healthlake.types.transformation_job_status.TransformationJobStatus"
] = None,
job_name: Optional[
"capo_healthlake.types.data_transformation_job_name.DataTransformationJobName"
] = None,
submitted_after: Optional["capo_healthlake.types.date_time.DateTime"] = None,
submitted_before: Optional["capo_healthlake.types.date_time.DateTime"] = None,
) -> "capo_healthlake.types.list_data_transformation_jobs_response.ListDataTransformationJobsResponse":
"""<p>Lists data transformation jobs for your Amazon Web Services account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the <code>NextToken</code> parameter to retrieve additional results.</p>
Args:
max_results: <p>The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.</p>
next_token: <p>The pagination token from a previous response. Pass this value to retrieve the next page of results.</p>
job_status: <p>Filters the results to include only jobs with the specified status.</p>
job_name: <p>Filters the results to include only jobs with the specified name.</p>
submitted_after: <p>Filters the results to include only jobs submitted at or after this timestamp.</p>
submitted_before: <p>Filters the results to include only jobs submitted at or before this timestamp.</p>
Raises:
capo_healthlake.errors.access_denied_exception.AccessDeniedException: <p>Access is denied. Your account is not authorized to perform this operation.</p>
capo_healthlake.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred in the service.</p>
capo_healthlake.errors.throttling_exception.ThrottlingException: <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
capo_healthlake.errors.validation_exception.ValidationException: <p>The user input parameter was invalid.</p>
capo_healthlake.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_healthlake.types.list_data_transformation_jobs_request.ListDataTransformationJobsRequest]",
) -> OperationResponse[
"capo_healthlake.types.list_data_transformation_jobs_response.ListDataTransformationJobsResponse"
]:
import capo_healthlake._operations.health_lake.list_data_transformation_jobs
output, http_response = (
capo_healthlake._operations.health_lake.list_data_transformation_jobs.list_data_transformation_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDataTransformationJobs")
)
input_: capo_healthlake.types.list_data_transformation_jobs_request.ListDataTransformationJobsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if job_status is not None:
input_["job_status"] = job_status
if job_name is not None:
input_["job_name"] = job_name
if submitted_after is not None:
input_["submitted_after"] = submitted_after
if submitted_before is not None:
input_["submitted_before"] = submitted_before
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|