View a markdown version of this page

AWS::Personalize::DataDeletionJob - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Personalize::DataDeletionJob

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::DataDeletionJob",
  "Properties" : {
      "DatasetGroupArn" : String,
      "DataSource" : DataSource,
      "JobName" : String,
      "RoleArn" : String
    }
}

YAML

Type: AWS::Personalize::DataDeletionJob
Properties:
  DatasetGroupArn: String
  DataSource: 
    DataSource
  JobName: String
  RoleArn: String

Properties

DatasetGroupArn

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

Required: No

Type: String

Pattern: ^arn:([a-z\d-]+):personalize:.*:.*:.+$

Maximum: 256

Update requires: Replacement

DataSource

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

Required: No

Type: DataSource

Update requires: Replacement

JobName

The name of the data deletion job.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*$

Minimum: 1

Maximum: 63

Update requires: Replacement

RoleArn

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

Required: No

Type: String

Pattern: ^arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Maximum: 256

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreationDateTime

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

DataDeletionJobArn

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

LastUpdatedDateTime

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

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