Personalize / Client / list_data_deletion_jobs

list_data_deletion_jobs#

Personalize.Client.list_data_deletion_jobs(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_data_deletion_jobs(
    datasetGroupArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • datasetGroupArn (string) – The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.

  • nextToken (string) – A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).

  • maxResults (integer) – The maximum number of data deletion jobs to return.

Return type:

dict

Returns:

Response Syntax

{
    'dataDeletionJobs': [
        {
            'dataDeletionJobArn': 'string',
            'datasetGroupArn': 'string',
            'jobName': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • dataDeletionJobs (list) –

      The list of data deletion jobs.

      • (dict) –

        Provides a summary of the properties of a data deletion job. For a complete listing, call the DescribeDataDeletionJob API operation.

        • dataDeletionJobArn (string) –

          The Amazon Resource Name (ARN) of the data deletion job.

        • datasetGroupArn (string) –

          The Amazon Resource Name (ARN) of the dataset group the job deleted records from.

        • jobName (string) –

          The name of the data deletion job.

        • status (string) –

          The status of the data deletion job.

          A data deletion job can have one of the following statuses:

          • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

        • creationDateTime (datetime) –

          The creation date and time (in Unix time) of the data deletion job.

        • lastUpdatedDateTime (datetime) –

          The date and time (in Unix time) the data deletion job was last updated.

        • failureReason (string) –

          If a data deletion job fails, provides the reason why.

    • nextToken (string) –

      A token for getting the next set of data deletion jobs (if they exist).

Exceptions