Class: AWS.Personalize

var params = {
  jobInput: { /* required */
    s3DataSource: { /* required */
      path: 'STRING_VALUE', /* required */
      kmsKeyArn: 'STRING_VALUE'
    }
  },
  jobName: 'STRING_VALUE', /* required */
  jobOutput: { /* required */
    s3DataDestination: { /* required */
      path: 'STRING_VALUE', /* required */
      kmsKeyArn: 'STRING_VALUE'
    }
  },
  roleArn: 'STRING_VALUE', /* required */
  solutionVersionArn: 'STRING_VALUE', /* required */
  filterArn: 'STRING_VALUE',
  numResults: 'NUMBER_VALUE',
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createBatchSegmentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobName — (String)

    The name of the batch segment job to create.

  • solutionVersionArn — (String)

    The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

  • filterArn — (String)

    The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

  • numResults — (Integer)

    The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

  • jobInput — (map)

    The Amazon S3 path for the input data used to generate the batch segment job.

    • s3DataSource — required — (map)

      The configuration details of an Amazon S3 input or output bucket.

      • path — required — (String)

        The file path of the Amazon S3 bucket.

      • kmsKeyArn — (String)

        The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

  • jobOutput — (map)

    The Amazon S3 path for the bucket where the job's output will be stored.

    • s3DataDestination — required — (map)

      The configuration details of an Amazon S3 input or output bucket.

      • path — required — (String)

        The file path of the Amazon S3 bucket.

      • kmsKeyArn — (String)

        The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

  • roleArn — (String)

    The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

  • tags — (Array<map>)

    A list of tags to apply to the batch segment job.

    • tagKey — required — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • tagValue — required — (String)

      The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • batchSegmentJobArn — (String)

      The ARN of the batch segment job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  solutionVersionArn: 'STRING_VALUE', /* required */
  campaignConfig: {
    enableMetadataWithRecommendations: true || false,
    itemExplorationConfig: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    },
    syncWithLatestSolutionVersion: true || false
  },
  minProvisionedTPS: 'NUMBER_VALUE',
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    A name for the new campaign. The campaign name must be unique within your account.

  • solutionVersionArn — (String)

    The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

    To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

    For more information about automatic campaign updates, see Enabling automatic campaign updates.

  • minProvisionedTPS — (Integer)

    Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

  • campaignConfig — (map)

    The configuration details of a campaign.

    • itemExplorationConfig — (map<String>)

      Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

    • enableMetadataWithRecommendations — (Boolean)

      Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

      If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

    • syncWithLatestSolutionVersion — (Boolean)

      Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

      For more information about automatic campaign updates, see Enabling automatic campaign updates.

  • tags — (Array<map>)

    A list of tags to apply to the campaign.

    • tagKey — required — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • tagValue — required — (String)

      The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • campaignArn — (String)

      The Amazon Resource Name (ARN) of the campaign.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSource: { /* required */
    dataLocation: 'STRING_VALUE'
  },
  datasetGroupArn: 'STRING_VALUE', /* required */
  jobName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createDataDeletionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobName — (String)

    The name for the data deletion job.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.

  • dataSource — (map)

    The Amazon S3 bucket that contains the list of userIds of the users to delete.

    • dataLocation — (String)

      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/

  • roleArn — (String)

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

  • tags — (Array<map>)

    A list of tags to apply to the data deletion job.

    • tagKey — required — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • tagValue — required — (String)

      The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataDeletionJobArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  datasetType: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  schemaArn: 'STRING_VALUE', /* required */
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name for the dataset.

  • schemaArn — (String)

    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

  • datasetType — (String)

    The type of dataset.

    One of the following (case insensitive) values:

    • Interactions

    • Items

    • Users

    • Actions

    • Action_Interactions

  • tags — (Array<map>)

    A list of tags to apply to the dataset.

    • tagKey — required — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • tagValue — required — (String)

      The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetArn — (String)

      The ARN of the dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetArn: 'STRING_VALUE', /* required */
  jobName: 'STRING_VALUE', /* required */
  jobOutput: { /* required */
    s3DataDestination: { /* required */
      path: 'STRING_VALUE', /* required */
      kmsKeyArn: 'STRING_VALUE'
    }
  },
  roleArn: 'STRING_VALUE', /* required */
  ingestionMode: BULK | PUT | ALL,
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createDatasetExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobName — (String)

    The name for the dataset export job.

  • datasetArn — (String)

    The Amazon Resource Name (ARN) of the dataset that contains the data to export.

  • ingestionMode — (String)

    The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

    Possible values include:
    • "BULK"
    • "PUT"
    • "ALL"
  • roleArn — (String)

    The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

  • jobOutput — (map)

    The path to the Amazon S3 bucket where the job's output is stored.

    • s3DataDestination — required — (map)

      The configuration details of an Amazon S3 input or output bucket.

      • path — required — (String)

        The file path of the Amazon S3 bucket.

      • kmsKeyArn — (String)

        The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

  • tags — (Array<map>)

    A list of tags to apply to the dataset export job.

    • tagKey — required — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • tagValue — required — (String)

      The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetExportJobArn — (String)

      The Amazon Resource Name (ARN) of the dataset export job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  domain: ECOMMERCE | VIDEO_ON_DEMAND,
  kmsKeyArn: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createDatasetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name for the new dataset group.

  • roleArn — (String)

    The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

  • kmsKeyArn — (String)

    The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.

  • domain — (String)

    The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.

    Possible values include:
    • "ECOMMERCE"
    • "VIDEO_ON_DEMAND"
  • tags — (Array<map>)

    A list of tags to apply to the dataset group.