Skip to content
AWS for Query.Farm

aws.personalize.describe_data_deletion_job

Example SQL Queries

SELECT * FROM
aws.personalize.describe_data_deletion_job
WHERE
"data_deletion_job_arn" = 'VALUE';

Description

Describes the data deletion job created by CreateDataDeletionJob, including the job status.

Table Definition

Column NameColumn Data Type
data_deletion_job_arn Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
data_deletion_job

Information about the data deletion job, including the status.

The status is one of the following values:

  • PENDING

  • IN_PROGRESS

  • COMPLETED

  • FAILED

STRUCT(
    "job_name" VARCHAR,
    "data_deletion_job_arn" VARCHAR,
    "dataset_group_arn" VARCHAR,
    "data_source" STRUCT(
        "data_location" VARCHAR
    ),
    "role_arn" VARCHAR,
    "status" VARCHAR,
    "num_deleted" BIGINT,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S,
    "failure_reason" VARCHAR
)
Show child fields
data_deletion_job.creation_date_time

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

data_deletion_job.data_deletion_job_arn

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

data_deletion_job.data_source

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

Show child fields
data_deletion_job.data_source.data_location

For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.

For example:

s3://bucket-name/folder-name/fileName.csv

If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder name:

s3://bucket-name/folder-name/

data_deletion_job.dataset_group_arn

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

data_deletion_job.failure_reason

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

data_deletion_job.job_name

The name of the data deletion job.

data_deletion_job.last_updated_date_time

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

data_deletion_job.num_deleted

The number of records deleted by a COMPLETED job.

data_deletion_job.role_arn

The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

data_deletion_job.status

The status of the data deletion job.

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

  • PENDING > IN_PROGRESS > COMPLETED -or- FAILED