Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
Parameters:
-
dataset_arn
(Optional[Arn], default:
None
)
–
The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of dataset export jobs to return.
Raises:
Source code in docs_src/capo_personalize/_services/personalize.py
| def list_dataset_export_jobs(
self,
*,
config_overrides: Optional[PersonalizeClientConfig] = None,
dataset_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_dataset_export_jobs_response.ListDatasetExportJobsResponse":
"""<p>Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
Args:
dataset_arn: <p>The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.</p>
next_token: <p>A token returned from the previous call to <code>ListDatasetExportJobs</code> for getting the next set of dataset export jobs (if they exist).</p>
max_results: <p>The maximum number of dataset export jobs to return.</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.
"""
def _handler(
req: "OperationRequest[capo_personalize.types.list_dataset_export_jobs_request.ListDatasetExportJobsRequest]",
) -> OperationResponse[
"capo_personalize.types.list_dataset_export_jobs_response.ListDatasetExportJobsResponse"
]:
import capo_personalize._operations.amazon_personalize.list_dataset_export_jobs
output, http_response = (
capo_personalize._operations.amazon_personalize.list_dataset_export_jobs.list_dataset_export_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDatasetExportJobs")
)
input_: capo_personalize.types.list_dataset_export_jobs_request.ListDatasetExportJobsRequest = {}
if dataset_arn is not None:
input_["dataset_arn"] = dataset_arn
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|