Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.
Parameters:
-
dataset_group_arn
(Optional[Arn], default:
None
)
–
The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of data deletion jobs to return.
Raises:
Source code in docs_src/capo_personalize/_services/personalize.py
| def list_data_deletion_jobs(
self,
*,
config_overrides: Optional[PersonalizeClientConfig] = None,
dataset_group_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_data_deletion_jobs_response.ListDataDeletionJobsResponse":
"""<p>Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html">Deleting users</a>.</p>
Args:
dataset_group_arn: <p>The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.</p>
next_token: <p>A token returned from the previous call to <code>ListDataDeletionJobs</code> for getting the next set of jobs (if they exist).</p>
max_results: <p>The maximum number of data deletion 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_data_deletion_jobs_request.ListDataDeletionJobsRequest]",
) -> OperationResponse[
"capo_personalize.types.list_data_deletion_jobs_response.ListDataDeletionJobsResponse"
]:
import capo_personalize._operations.amazon_personalize.list_data_deletion_jobs
output, http_response = (
capo_personalize._operations.amazon_personalize.list_data_deletion_jobs.list_data_deletion_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDataDeletionJobs")
)
input_: capo_personalize.types.list_data_deletion_jobs_request.ListDataDeletionJobsRequest = {}
if dataset_group_arn is not None:
input_["dataset_group_arn"] = dataset_group_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
|