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.

    • 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:

    • datasetGroupArn — (String)

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

    • domain — (String)

      The domain for the new Domain dataset group.

      Possible values include:
      • "ECOMMERCE"
      • "VIDEO_ON_DEMAND"

Returns:

• (AWS.Request) —

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

var params = {
  dataSource: { /* required */
    dataLocation: 'STRING_VALUE'
  },
  datasetArn: 'STRING_VALUE', /* required */
  jobName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  importMode: FULL | INCREMENTAL,
  publishAttributionMetricsToS3: true || false,
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createDatasetImportJob(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 import job.

  • datasetArn — (String)

    The ARN of the dataset that receives the imported data.

  • dataSource — (map)

    The Amazon S3 bucket that contains the training data to import.

    • 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 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 dataset import 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).

  • importMode — (String)

    Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.

    • Specify FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.

    • Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

    Possible values include:
    • "FULL"
    • "INCREMENTAL"
  • publishAttributionMetricsToS3 — (Boolean)

    If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

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:

    • datasetImportJobArn — (String)

      The ARN of the dataset import job.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createEventTracker(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 event tracker.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the dataset group that receives the event data.

  • tags — (Array<map>)

    A list of tags to apply to the event tracker.

    • 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:

    • eventTrackerArn — (String)

      The ARN of the event tracker.

    • trackingId — (String)

      The ID of the event tracker. Include this ID in requests to the PutEvents API.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  filterExpression: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createFilter(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 of the filter to create.

  • datasetGroupArn — (String)

    The ARN of the dataset group that the filter will belong to.

  • filterExpression — (String)

    The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

  • tags — (Array<map>)

    A list of tags to apply to the filter.

    • 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:

    • filterArn — (String)

      The ARN of the new filter.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  metrics: [ /* required */
    {
      eventType: 'STRING_VALUE', /* required */
      expression: 'STRING_VALUE', /* required */
      metricName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  metricsOutputConfig: { /* required */
    roleArn: 'STRING_VALUE', /* required */
    s3DataDestination: {
      path: 'STRING_VALUE', /* required */
      kmsKeyArn: 'STRING_VALUE'
    }
  },
  name: 'STRING_VALUE' /* required */
};
personalize.createMetricAttribution(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 metric attribution.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

  • metrics — (Array<map>)

    A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

    • eventType — required — (String)

      The metric's event type.

    • metricName — required — (String)

      The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

    • expression — required — (String)

      The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

  • metricsOutputConfig — (map)

    The output configuration details for the metric attribution.

    • s3DataDestination — (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 — required — (String)

      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.

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:

    • metricAttributionArn — (String)

      The Amazon Resource Name (ARN) for the new metric attribution.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  recipeArn: 'STRING_VALUE', /* required */
  recommenderConfig: {
    enableMetadataWithRecommendations: true || false,
    itemExplorationConfig: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    },
    minRecommendationRequestsPerSecond: 'NUMBER_VALUE',
    trainingDataConfig: {
      excludedDatasetColumns: {
        '<DatasetType>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<DatasetType>': ... */
      }
    }
  },
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createRecommender(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 of the recommender.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

  • recipeArn — (String)

    The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

  • recommenderConfig — (map)

    The configuration details of the recommender.

    • 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 recommenders generate personalized recommendations for a user (not popular items or similar items).

    • minRecommendationRequestsPerSecond — (Integer)

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

    • trainingDataConfig — (map)

      Specifies the training data configuration to use when creating a domain recommender.

      • excludedDatasetColumns — (map<Array<String>>)

        Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

        For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

    • enableMetadataWithRecommendations — (Boolean)

      Whether metadata with recommendations is enabled for the recommender. 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 recommender, see Enabling metadata in recommendations for a recommender.

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

  • tags — (Array<map>)

    A list of tags to apply to the recommender.

    • 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:

    • recommenderArn — (String)

      The Amazon Resource Name (ARN) of the recommender.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  schema: 'STRING_VALUE', /* required */
  domain: ECOMMERCE | VIDEO_ON_DEMAND
};
personalize.createSchema(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 schema.

  • schema — (String)

    A schema in Avro JSON format.

  • domain — (String)

    The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

    Possible values include:
    • "ECOMMERCE"
    • "VIDEO_ON_DEMAND"

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:

    • schemaArn — (String)

      The Amazon Resource Name (ARN) of the created schema.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  eventType: 'STRING_VALUE',
  performAutoML: true || false,
  performAutoTraining: true || false,
  performHPO: true || false,
  recipeArn: 'STRING_VALUE',
  solutionConfig: {
    algorithmHyperParameters: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    },
    autoMLConfig: {
      metricName: 'STRING_VALUE',
      recipeList: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    autoTrainingConfig: {
      schedulingExpression: 'STRING_VALUE'
    },
    eventValueThreshold: 'STRING_VALUE',
    featureTransformationParameters: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    },
    hpoConfig: {
      algorithmHyperParameterRanges: {
        categoricalHyperParameterRanges: [
          {
            name: 'STRING_VALUE',
            values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        continuousHyperParameterRanges: [
          {
            maxValue: 'NUMBER_VALUE',
            minValue: 'NUMBER_VALUE',
            name: 'STRING_VALUE'
          },
          /* more items */
        ],
        integerHyperParameterRanges: [
          {
            maxValue: 'NUMBER_VALUE',
            minValue: 'NUMBER_VALUE',
            name: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      hpoObjective: {
        metricName: 'STRING_VALUE',
        metricRegex: 'STRING_VALUE',
        type: 'STRING_VALUE'
      },
      hpoResourceConfig: {
        maxNumberOfTrainingJobs: 'STRING_VALUE',
        maxParallelTrainingJobs: 'STRING_VALUE'
      }
    },
    optimizationObjective: {
      itemAttribute: 'STRING_VALUE',
      objectiveSensitivity: LOW | MEDIUM | HIGH | OFF
    },
    trainingDataConfig: {
      excludedDatasetColumns: {
        '<DatasetType>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<DatasetType>': ... */
      }
    }
  },
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
personalize.createSolution(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 solution.

  • performHPO — (Boolean)

    Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

    When performing AutoML, this parameter is always true and you should not set it to false.

  • performAutoML — (Boolean)

    We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

    Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

    When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

  • performAutoTraining — (Boolean)

    Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

    Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

    After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

  • recipeArn — (String)

    The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

  • datasetGroupArn — (String)

    The Amazon Resource Name (ARN) of the dataset group that provides the training data.

  • eventType — (String)

    When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

    If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

  • solutionConfig — (map)

    The configuration properties for the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

    Note: Amazon Personalize doesn't support configuring the hpoObjective at this time.
    • eventValueThreshold — (String)

      Only events with a value greater than or equal to this threshold are used for training a model.

    • hpoConfig — (map)

      Describes the properties for hyperparameter optimization (HPO).

      • hpoObjective — (map)

        The metric to optimize during HPO.

        Note: Amazon Personalize doesn't support configuring the hpoObjective at this time.
        • type — (String)

          The type of the metric. Valid values are Maximize and Minimize.

        • metricName — (String)

          The name of the metric.

        • metricRegex — (String)

          A regular expression for finding the metric in the training job logs.

      • hpoResourceConfig — (map)

        Describes the resource configuration for HPO.

        • maxNumberOfTrainingJobs — (String)

          The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

        • maxParallelTrainingJobs — (String)

          The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

      • algorithmHyperParameterRanges — (map)

        The hyperparameters and their allowable ranges.

        • integerHyperParameterRanges — (Array<map>)

          The integer-valued hyperparameters and their ranges.

          • name — (String)

            The name of the hyperparameter.

          • minValue — (Integer)

            The minimum allowable value for the hyperparameter.

          • maxValue — (Integer)

            The maximum allowable value for the hyperparameter.

        • continuousHyperParameterRanges — (Array<map>)

          The continuous hyperparameters and their ranges.

          • name — (String)

            The name of the hyperparameter.

          • minValue — (Float)

            The minimum allowable value for the hyperparameter.

          • maxValue — (Float)

            The maximum allowable value for the hyperparameter.

        • categoricalHyperParameterRanges — (Array<map>)

          The categorical hyperparameters and their ranges.

          • name — (String)

            The name of the hyperparameter.

          • values — (Array<String>)

            A list of the categories for the hyperparameter.

    • algorithmHyperParameters — (map<String>)

      Lists the algorithm hyperparameters and their values.

    • featureTransformationParameters — (map<String>)

      Lists the feature transformation parameters.

    • autoMLConfig — (map)

      The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

      • metricName — (String)

        The metric to optimize.

      • recipeList — (Array<String>)

        The list of candidate recipes.

    • optimizationObjective — (map)

      Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

      • itemAttribute — (String)

        The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

      • objectiveSensitivity — (String)

        Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

        Possible values include:
        • "LOW"
        • "MEDIUM"
        • "HIGH"
        • "OFF"
    • trainingDataConfig — (map)

      Specifies the training data configuration to use when creating a custom solution version (trained model).

      • excludedDatasetColumns — (map<Array<String>>)

        Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

        For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

    • autoTrainingConfig — (map)

      Specifies the automatic training configuration to use.

      • schedulingExpression — (String)

        Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

        For more information about auto training, see Creating and configuring a solution.

  • tags — (Array<map>)

    A list of tags to apply to the solution.

    • 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:

    • solutionArn — (String)

      The ARN of the solution.

Returns:

• (AWS.Request) —

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

var params = {
  solutionArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE',
  tags: [
    {
      tagKey: 'STRING_VALUE', /* required */
      tagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  trainingMode: FULL | UPDATE | AUTOTRAIN
};
personalize.createSolutionVersion(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 of the solution version.

  • solutionArn — (String)

    The Amazon Resource Name (ARN) of the solution containing the training configuration information.

  • trainingMode — (String)

    The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group.

    If you use User-Personalization, you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates.

    The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the legacy HRNN-Coldstart recipe.

    Possible values include:
    • "FULL"
    • "UPDATE"
    • "AUTOTRAIN"
  • tags — (Array<map>)

    A list of tags to apply to the solution version.

    • 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:

    • solutionVersionArn — (String)

      The ARN of the new solution version.

Returns:

• (AWS.Request) —

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

var params = {
  campaignArn: 'STRING_VALUE' /* required */
};
personalize.deleteCampaign(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: {}) —
  • campaignArn — (String)

    The Amazon Resource Name (ARN) of the campaign to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  datasetArn: 'STRING_VALUE' /* required */
};
personalize.deleteDataset(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: {}) —
  • datasetArn — (String)

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

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.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE' /* required */
};
personalize.deleteDatasetGroup(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: {}) —
  • datasetGroupArn — (String)

    The ARN of the dataset group to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  eventTrackerArn: 'STRING_VALUE' /* required */
};
personalize.deleteEventTracker(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: {}) —
  • eventTrackerArn — (String)

    The Amazon Resource Name (ARN) of the event tracker to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  filterArn: 'STRING_VALUE' /* required */
};
personalize.deleteFilter(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: {}) —
  • filterArn — (String)

    The ARN of the filter to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  metricAttributionArn: 'STRING_VALUE' /* required */
};
personalize.deleteMetricAttribution(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: {}) —
  • metricAttributionArn — (String)

    The metric attribution's Amazon Resource Name (ARN).

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.

Returns:

• (AWS.Request) —

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

var params = {
  recommenderArn: 'STRING_VALUE' /* required */
};
personalize.deleteRecommender(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: {}) —
  • recommenderArn — (String)

    The Amazon Resource Name (ARN) of the recommender to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  schemaArn: 'STRING_VALUE' /* required */
};
personalize.deleteSchema(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: {}) —
  • schemaArn — (String)

    The Amazon Resource Name (ARN) of the schema to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  solutionArn: 'STRING_VALUE' /* required */
};
personalize.deleteSolution(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: {}) —
  • solutionArn — (String)

    The ARN of the solution to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  algorithmArn: 'STRING_VALUE' /* required */
};
personalize.describeAlgorithm(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: {}) —
  • algorithmArn — (String)

    The Amazon Resource Name (ARN) of the algorithm to describe.

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:

    • algorithm — (map)

      A listing of the properties of the algorithm.

      • name — (String)

        The name of the algorithm.

      • algorithmArn — (String)

        The Amazon Resource Name (ARN) of the algorithm.

      • algorithmImage — (map)

        The URI of the Docker container for the algorithm image.

        • name — (String)

          The name of the algorithm image.

        • dockerURI — required — (String)

          The URI of the Docker container for the algorithm image.

      • defaultHyperParameters — (map<String>)

        Specifies the default hyperparameters.

      • defaultHyperParameterRanges — (map)

        Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

        • integerHyperParameterRanges — (Array<map>)

          The integer-valued hyperparameters and their default ranges.

          • name — (String)

            The name of the hyperparameter.

          • minValue — (Integer)

            The minimum allowable value for the hyperparameter.

          • maxValue — (Integer)

            The maximum allowable value for the hyperparameter.

          • isTunable — (Boolean)

            Indicates whether the hyperparameter is tunable.

        • continuousHyperParameterRanges — (Array<map>)

          The continuous hyperparameters and their default ranges.

          • name — (String)

            The name of the hyperparameter.

          • minValue — (Float)

            The minimum allowable value for the hyperparameter.

          • maxValue — (Float)

            The maximum allowable value for the hyperparameter.

          • isTunable — (Boolean)

            Whether the hyperparameter is tunable.

        • categoricalHyperParameterRanges — (Array<map>)

          The categorical hyperparameters and their default ranges.

          • name — (String)

            The name of the hyperparameter.

          • values — (Array<String>)

            A list of the categories for the hyperparameter.

          • isTunable — (Boolean)

            Whether the hyperparameter is tunable.

      • defaultResourceConfig — (map<String>)

        Specifies the default maximum number of training jobs and parallel training jobs.

      • trainingInputMode — (String)

        The training input mode.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of the role.

      • creationDateTime — (Date)

        The date and time (in Unix time) that the algorithm was created.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) that the algorithm was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  batchInferenceJobArn: 'STRING_VALUE' /* required */
};
personalize.describeBatchInferenceJob(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: {}) —
  • batchInferenceJobArn — (String)

    The ARN of the batch inference job to describe.

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:

    • batchInferenceJob — (map)

      Information on the specified batch inference job.

      • jobName — (String)

        The name of the batch inference job.

      • batchInferenceJobArn — (String)

        The Amazon Resource Name (ARN) of the batch inference job.

      • filterArn — (String)

        The ARN of the filter used on the batch inference job.

      • failureReason — (String)

        If the batch inference job failed, the reason for the failure.

      • solutionVersionArn — (String)

        The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

      • numResults — (Integer)

        The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

      • jobInput — (map)

        The Amazon S3 path that leads to the input data used to generate the batch inference job.

        • s3DataSource — required — (map)

          The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.

          • 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 bucket that contains the output data generated by the batch inference job.

        • s3DataDestination — required — (map)

          Information on the Amazon S3 bucket in which the batch inference job's output is stored.

          • 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.

      • batchInferenceJobConfig — (map)

        A string to string map of the configuration details of a batch inference job.

        • itemExplorationConfig — (map<String>)

          A string to string map specifying 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. See User-Personalization.

      • roleArn — (String)

        The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

      • batchInferenceJobMode — (String)

        The job's mode.

        Possible values include:
        • "BATCH_INFERENCE"
        • "THEME_GENERATION"
      • themeGenerationConfig — (map)

        The job's theme generation settings.

        • fieldsForThemeGeneration — required — (map)

          Fields used to generate descriptive themes for a batch inference job.

          • itemName — required — (String)

            The name of the Items dataset column that stores the name of each item in the dataset.

      • status — (String)

        The status of the batch inference job. The status is one of the following values:

        • PENDING

        • IN PROGRESS

        • ACTIVE

        • CREATE FAILED

      • creationDateTime — (Date)

        The time at which the batch inference job was created.

      • lastUpdatedDateTime — (Date)

        The time at which the batch inference job was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  batchSegmentJobArn: 'STRING_VALUE' /* required */
};
personalize.describeBatchSegmentJob(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: {}) —
  • batchSegmentJobArn — (String)

    The ARN of the batch segment job to describe.

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:

    • batchSegmentJob — (map)

      Information on the specified batch segment job.

      • jobName — (String)

        The name of the batch segment job.

      • batchSegmentJobArn — (String)

        The Amazon Resource Name (ARN) of the batch segment job.

      • filterArn — (String)

        The ARN of the filter used on the batch segment job.

      • failureReason — (String)

        If the batch segment job failed, the reason for the failure.

      • solutionVersionArn — (String)

        The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

      • 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 that leads to 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 bucket that contains the output data generated by the batch segment job.

        • 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 (IAM) role that requested the batch segment job.

      • status — (String)

        The status of the batch segment job. The status is one of the following values:

        • PENDING

        • IN PROGRESS

        • ACTIVE

        • CREATE FAILED

      • creationDateTime — (Date)

        The time at which the batch segment job was created.

      • lastUpdatedDateTime — (Date)

        The time at which the batch segment job last updated.

Returns:

• (AWS.Request) —

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

var params = {
  campaignArn: 'STRING_VALUE' /* required */
};
personalize.describeCampaign(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: {}) —
  • campaignArn — (String)

    The Amazon Resource Name (ARN) of the campaign.

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:

    • campaign — (map)

      The properties of the campaign.

      • name — (String)

        The name of the campaign.

      • campaignArn — (String)

        The Amazon Resource Name (ARN) of the campaign.

      • solutionVersionArn — (String)

        The Amazon Resource Name (ARN) of the solution version the campaign uses.

      • minProvisionedTPS — (Integer)

        Specifies the requested minimum provisioned transactions (recommendations) per second. 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.

      • status — (String)

        The status of the campaign.

        A campaign can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • DELETE PENDING > DELETE IN_PROGRESS

      • failureReason — (String)

        If a campaign fails, the reason behind the failure.

      • creationDateTime — (Date)

        The date and time (in Unix format) that the campaign was created.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix format) that the campaign was last updated.

      • latestCampaignUpdate — (map)

        Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

        • solutionVersionArn — (String)

          The Amazon Resource Name (ARN) of the deployed solution version.

        • minProvisionedTPS — (Integer)

          Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

        • 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.

        • status — (String)

          The status of the campaign update.

          A campaign update can be in one of the following states:

          • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

          • DELETE PENDING > DELETE IN_PROGRESS

        • failureReason — (String)

          If a campaign update fails, the reason behind the failure.

        • creationDateTime — (Date)

          The date and time (in Unix time) that the campaign update was created.

        • lastUpdatedDateTime — (Date)

          The date and time (in Unix time) that the campaign update was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  dataDeletionJobArn: 'STRING_VALUE' /* required */
};
personalize.describeDataDeletionJob(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: {}) —
  • dataDeletionJobArn — (String)

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

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:

    • dataDeletionJob — (map)

      Information about the data deletion job, including the status.

      The status is one of the following values:

      • PENDING

      • IN_PROGRESS

      • COMPLETED

      • FAILED

      • jobName — (String)

        The name of the data deletion job.

      • 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 deletes records from.

      • dataSource — (map)

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

        • 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.

      • 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

      • numDeleted — (Integer)

        The number of records deleted by a COMPLETED job.

      • creationDateTime — (Date)

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

      • lastUpdatedDateTime — (Date)

        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.

Returns:

• (AWS.Request) —

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

var params = {
  datasetArn: 'STRING_VALUE' /* required */
};
personalize.describeDataset(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: {}) —
  • datasetArn — (String)

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

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:

    • dataset — (map)

      A listing of the dataset's properties.

      • name — (String)

        The name of the dataset.

      • datasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset that you want metadata for.

      • datasetGroupArn — (String)

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

      • datasetType — (String)

        One of the following values:

        • Interactions

        • Items

        • Users

        • Actions

        • Action_Interactions

      • schemaArn — (String)

        The ARN of the associated schema.

      • status — (String)

        The status of the dataset.

        A dataset can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the dataset.

      • lastUpdatedDateTime — (Date)

        A time stamp that shows when the dataset was updated.

      • latestDatasetUpdate — (map)

        Describes the latest update to the dataset.

        • schemaArn — (String)

          The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

        • status — (String)

          The status of the dataset update.

        • failureReason — (String)

          If updating a dataset fails, provides the reason why.

        • creationDateTime — (Date)

          The creation date and time (in Unix time) of the dataset update.

        • lastUpdatedDateTime — (Date)

          The last update date and time (in Unix time) of the dataset.

      • trackingId — (String)

        The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

Returns:

• (AWS.Request) —

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

var params = {
  datasetExportJobArn: 'STRING_VALUE' /* required */
};
personalize.describeDatasetExportJob(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: {}) —
  • datasetExportJobArn — (String)

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

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:

    • datasetExportJob — (map)

      Information about the dataset export job, including the status.

      The status is one of the following values:

      • CREATE PENDING

      • CREATE IN_PROGRESS

      • ACTIVE

      • CREATE FAILED

      • jobName — (String)

        The name of the export job.

      • datasetExportJobArn — (String)

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

      • datasetArn — (String)

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

      • ingestionMode — (String)

        The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, 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.

      • status — (String)

        The status of the dataset export job.

        A dataset export job can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • jobOutput — (map)

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

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

        • 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.

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the dataset export job.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) the status of the dataset export job was last updated.

      • failureReason — (String)

        If a dataset export job fails, provides the reason why.

Returns:

• (AWS.Request) —

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

var params = {
  datasetGroupArn: 'STRING_VALUE' /* required */
};
personalize.describeDatasetGroup(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: {}) —
  • datasetGroupArn — (String)

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

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:

    • datasetGroup — (map)

      A listing of the dataset group's properties.

      • name — (String)

        The name of the dataset group.

      • datasetGroupArn — (String)

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

      • status — (String)

        The current status of the dataset group.

        A dataset group can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • DELETE PENDING

      • 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 the Key Management Service (KMS) key used to encrypt the datasets.

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the dataset group.

      • lastUpdatedDateTime — (Date)

        The last update date and time (in Unix time) of the dataset group.

      • failureReason — (String)

        If creating a dataset group fails, provides the reason why.

      • domain — (String)

        The domain of a Domain dataset group.

        Possible values include:
        • "ECOMMERCE"
        • "VIDEO_ON_DEMAND"

Returns:

• (AWS.Request) —

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

var params = {
  datasetImportJobArn: 'STRING_VALUE' /* required */
};
personalize.describeDatasetImportJob(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: {}) —
  • datasetImportJobArn — (String)

    The Amazon Resource Name (ARN) of the dataset import job to describe.

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:

    • datasetImportJob — (map)

      Information about the dataset import job, including the status.

      The status is one of the following values:

      • CREATE PENDING

      • CREATE IN_PROGRESS

      • ACTIVE

      • CREATE FAILED

      • jobName — (String)

        The name of the import job.

      • datasetImportJobArn — (String)

        The ARN of the dataset import job.

      • datasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset that receives the imported data.

      • dataSource — (map)

        The Amazon S3 bucket that contains the training data to import.

        • 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 ARN of the IAM role that has permissions to read from the Amazon S3 data source.

      • status — (String)

        The status of the dataset import job.

        A dataset import job can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the dataset import job.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) the dataset was last updated.

      • failureReason — (String)

        If a dataset import job fails, provides the reason why.

      • importMode — (String)

        The import mode used by the dataset import job to import new records.

        Possible values include:
        • "FULL"
        • "INCREMENTAL"
      • publishAttributionMetricsToS3 — (Boolean)

        Whether the job publishes metrics to Amazon S3 for a metric attribution.

Returns:

• (AWS.Request) —

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

var params = {
  eventTrackerArn: 'STRING_VALUE' /* required */
};
personalize.describeEventTracker(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: {}) —
  • eventTrackerArn — (String)

    The Amazon Resource Name (ARN) of the event tracker to describe.

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:

    • eventTracker — (map)

      An object that describes the event tracker.

      • name — (String)

        The name of the event tracker.

      • eventTrackerArn — (String)

        The ARN of the event tracker.

      • accountId — (String)

        The Amazon Web Services account that owns the event tracker.

      • trackingId — (String)

        The ID of the event tracker. Include this ID in requests to the PutEvents API.

      • datasetGroupArn — (String)

        The Amazon Resource Name (ARN) of the dataset group that receives the event data.

      • status — (String)

        The status of the event tracker.

        An event tracker can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime — (Date)

        The date and time (in Unix format) that the event tracker was created.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) that the event tracker was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  featureTransformationArn: 'STRING_VALUE' /* required */
};
personalize.describeFeatureTransformation(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: {}) —
  • featureTransformationArn — (String)

    The Amazon Resource Name (ARN) of the feature transformation to describe.

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:

    • featureTransformation — (map)

      A listing of the FeatureTransformation properties.

      • name — (String)

        The name of the feature transformation.

      • featureTransformationArn — (String)

        The Amazon Resource Name (ARN) of the FeatureTransformation object.

      • defaultParameters — (map<String>)

        Provides the default parameters for feature transformation.

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the feature transformation.

      • lastUpdatedDateTime — (Date)

        The last update date and time (in Unix time) of the feature transformation.

      • status — (String)

        The status of the feature transformation.

        A feature transformation can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

Returns:

• (AWS.Request) —

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

var params = {
  filterArn: 'STRING_VALUE' /* required */
};
personalize.describeFilter(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: {}) —
  • filterArn — (String)

    The ARN of the filter to describe.

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:

    • filter — (map)

      The filter's details.

      • name — (String)

        The name of the filter.

      • filterArn — (String)

        The ARN of the filter.

      • creationDateTime — (Date)

        The time at which the filter was created.

      • lastUpdatedDateTime — (Date)

        The time at which the filter was last updated.

      • datasetGroupArn — (String)

        The ARN of the dataset group to which the filter belongs.

      • failureReason — (String)

        If the filter failed, the reason for its failure.

      • filterExpression — (String)

        Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

      • status — (String)

        The status of the filter.

Returns:

• (AWS.Request) —

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

var params = {
  metricAttributionArn: 'STRING_VALUE' /* required */
};
personalize.describeMetricAttribution(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: {}) —
  • metricAttributionArn — (String)

    The metric attribution's Amazon Resource Name (ARN).

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:

    • metricAttribution — (map)

      The details of the metric attribution.

      • name — (String)

        The metric attribution's name.

      • metricAttributionArn — (String)

        The metric attribution's Amazon Resource Name (ARN).

      • datasetGroupArn — (String)

        The metric attribution's dataset group Amazon Resource Name (ARN).

      • metricsOutputConfig — (map)

        The metric attribution's output configuration.

        • s3DataDestination — (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 — required — (String)

          The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.

      • status — (String)

        The metric attribution's status.

      • creationDateTime — (Date)

        The metric attribution's creation date time.

      • lastUpdatedDateTime — (Date)

        The metric attribution's last updated date time.

      • failureReason — (String)

        The metric attribution's failure reason.

Returns:

• (AWS.Request) —

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

var params = {
  recipeArn: 'STRING_VALUE' /* required */
};
personalize.describeRecipe(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: {}) —
  • recipeArn — (String)

    The Amazon Resource Name (ARN) of the recipe to describe.

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:

    • recipe — (map)

      An object that describes the recipe.

      • name — (String)

        The name of the recipe.

      • recipeArn — (String)

        The Amazon Resource Name (ARN) of the recipe.

      • algorithmArn — (String)

        The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

      • featureTransformationArn — (String)

        The ARN of the FeatureTransformation object.

      • status — (String)

        The status of the recipe.

      • description — (String)

        The description of the recipe.

      • creationDateTime — (Date)

        The date and time (in Unix format) that the recipe was created.

      • recipeType — (String)

        One of the following values:

        • PERSONALIZED_RANKING

        • RELATED_ITEMS

        • USER_PERSONALIZATION

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix format) that the recipe was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  recommenderArn: 'STRING_VALUE' /* required */
};
personalize.describeRecommender(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: {}) —
  • recommenderArn — (String)

    The Amazon Resource Name (ARN) of the recommender to describe.

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:

    • recommender — (map)

      The properties of the recommender.

      • recommenderArn — (String)

        The Amazon Resource Name (ARN) of the recommender.

      • datasetGroupArn — (String)

        The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

      • name — (String)

        The name of the recommender.

      • recipeArn — (String)

        The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

      • recommenderConfig — (map)

        The configuration details of the recommender.

        • 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 recommenders generate personalized recommendations for a user (not popular items or similar items).

        • minRecommendationRequestsPerSecond — (Integer)

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

        • trainingDataConfig — (map)

          Specifies the training data configuration to use when creating a domain recommender.

          • excludedDatasetColumns — (map<Array<String>>)

            Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

            For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

        • enableMetadataWithRecommendations — (Boolean)

          Whether metadata with recommendations is enabled for the recommender. 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 recommender, see Enabling metadata in recommendations for a recommender.

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

      • creationDateTime — (Date)

        The date and time (in Unix format) that the recommender was created.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix format) that the recommender was last updated.

      • status — (String)

        The status of the recommender.

        A recommender can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

        • DELETE PENDING > DELETE IN_PROGRESS

      • failureReason — (String)

        If a recommender fails, the reason behind the failure.

      • latestRecommenderUpdate — (map)

        Provides a summary of the latest updates to the recommender.

        • recommenderConfig — (map)

          The configuration details of the recommender update.

          • 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 recommenders generate personalized recommendations for a user (not popular items or similar items).

          • minRecommendationRequestsPerSecond — (Integer)

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

          • trainingDataConfig — (map)

            Specifies the training data configuration to use when creating a domain recommender.

            • excludedDatasetColumns — (map<Array<String>>)

              Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

              For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

          • enableMetadataWithRecommendations — (Boolean)

            Whether metadata with recommendations is enabled for the recommender. 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 recommender, see Enabling metadata in recommendations for a recommender.

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

        • creationDateTime — (Date)

          The date and time (in Unix format) that the recommender update was created.

        • lastUpdatedDateTime — (Date)

          The date and time (in Unix time) that the recommender update was last updated.

        • status — (String)

          The status of the recommender update. A recommender update can be in one of the following states:

          CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • failureReason — (String)

          If a recommender update fails, the reason behind the failure.

      • modelMetrics — (map<Float>)

        Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

Returns:

• (AWS.Request) —

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

var params = {
  schemaArn: 'STRING_VALUE' /* required */
};
personalize.describeSchema(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: {}) —
  • schemaArn — (String)

    The Amazon Resource Name (ARN) of the schema to retrieve.

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:

    • schema — (map)

      The requested schema.

      • name — (String)

        The name of the schema.

      • schemaArn — (String)

        The Amazon Resource Name (ARN) of the schema.

      • schema — (String)

        The schema.

      • creationDateTime — (Date)

        The date and time (in Unix time) that the schema was created.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) that the schema was last updated.

      • domain — (String)

        The domain of a schema that you created for a dataset in a Domain dataset group.

        Possible values include:
        • "ECOMMERCE"
        • "VIDEO_ON_DEMAND"

Returns:

• (AWS.Request) —

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

var params = {
  solutionArn: 'STRING_VALUE' /* required */
};
personalize.describeSolution(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: {}) —
  • solutionArn — (String)

    The Amazon Resource Name (ARN) of the solution to describe.

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:

    • solution — (map)

      An object that describes the solution.

      • name — (String)

        The name of the solution.

      • solutionArn — (String)

        The ARN of the solution.

      • performHPO — (Boolean)

        Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

      • performAutoML — (Boolean)

        We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

        When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

      • performAutoTraining — (Boolean)

        Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.

        For more information about auto training, see Creating and configuring a solution.

      • recipeArn — (String)

        The ARN of the recipe used to create the solution. This is required when performAutoML is false.

      • datasetGroupArn — (String)

        The Amazon Resource Name (ARN) of the dataset group that provides the training data.

      • eventType — (String)

        The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

      • solutionConfig — (map)

        Describes the configuration properties for the solution.

        • eventValueThreshold — (String)

          Only events with a value greater than or equal to this threshold are used for training a model.

        • hpoConfig — (map)

          Describes the properties for hyperparameter optimization (HPO).

          • hpoObjective — (map)

            The metric to optimize during HPO.

            Note: Amazon Personalize doesn't support configuring the hpoObjective at this time.
            • type — (String)

              The type of the metric. Valid values are Maximize and Minimize.

            • metricName — (String)

              The name of the metric.

            • metricRegex — (String)

              A regular expression for finding the metric in the training job logs.

          • hpoResourceConfig — (map)

            Describes the resource configuration for HPO.

            • maxNumberOfTrainingJobs — (String)

              The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

            • maxParallelTrainingJobs — (String)

              The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

          • algorithmHyperParameterRanges — (map)

            The hyperparameters and their allowable ranges.

            • integerHyperParameterRanges — (Array<map>)

              The integer-valued hyperparameters and their ranges.

              • name — (String)

                The name of the hyperparameter.

              • minValue — (Integer)

                The minimum allowable value for the hyperparameter.

              • maxValue — (Integer)

                The maximum allowable value for the hyperparameter.

            • continuousHyperParameterRanges — (Array<map>)

              The continuous hyperparameters and their ranges.

              • name — (String)

                The name of the hyperparameter.

              • minValue — (Float)

                The minimum allowable value for the hyperparameter.

              • maxValue — (Float)

                The maximum allowable value for the hyperparameter.

            • categoricalHyperParameterRanges — (Array<map>)

              The categorical hyperparameters and their ranges.

              • name — (String)

                The name of the hyperparameter.

              • values — (Array<String>)

                A list of the categories for the hyperparameter.

        • algorithmHyperParameters — (map<String>)

          Lists the algorithm hyperparameters and their values.

        • featureTransformationParameters — (map<String>)

          Lists the feature transformation parameters.

        • autoMLConfig — (map)

          The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

          • metricName — (String)

            The metric to optimize.

          • recipeList — (Array<String>)

            The list of candidate recipes.

        • optimizationObjective — (map)

          Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

          • itemAttribute — (String)

            The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

          • objectiveSensitivity — (String)

            Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

            Possible values include:
            • "LOW"
            • "MEDIUM"
            • "HIGH"
            • "OFF"
        • trainingDataConfig — (map)

          Specifies the training data configuration to use when creating a custom solution version (trained model).

          • excludedDatasetColumns — (map<Array<String>>)

            Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

            For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

        • autoTrainingConfig — (map)

          Specifies the automatic training configuration to use.

          • schedulingExpression — (String)

            Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

            For more information about auto training, see Creating and configuring a solution.

      • autoMLResult — (map)

        When performAutoML is true, specifies the best recipe found.

        • bestRecipeArn — (String)

          The Amazon Resource Name (ARN) of the best recipe.

      • status — (String)

        The status of the solution.

        A solution can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime — (Date)

        The creation date and time (in Unix time) of the solution.

      • lastUpdatedDateTime — (Date)

        The date and time (in Unix time) that the solution was last updated.

      • latestSolutionVersion — (map)

        Describes the latest version of the solution, including the status and the ARN.

        • solutionVersionArn — (String)

          The Amazon Resource Name (ARN) of the solution version.

        • status — (String)

          The status of the solution version.

          A solution version can be in one of the following states:

          • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • trainingMode — (String)

          The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

          Possible values include:
          • "FULL"
          • "UPDATE"
          • "AUTOTRAIN"
        • trainingType — (String)

          Whether the solution version was created automatically or manually.

          Possible values include:
          • "AUTOMATIC"
          • "MANUAL"
        • creationDateTime — (Date)

          The date and time (in Unix time) that this version of a solution was created.

        • lastUpdatedDateTime — (Date)

          The date and time (in Unix time) that the solution version was last updated.

        • failureReason — (String)

          If a solution version fails, the reason behind the failure.

      • latestSolutionUpdate — (map)

        Provides a summary of the latest updates to the solution.

        • solutionUpdateConfig — (map)

          The configuration details of the solution.

          • autoTrainingConfig — (map)

            The automatic training configuration to use when performAutoTraining is true.

            • schedulingExpression — (String)

              Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

              For more information about auto training, see Creating and configuring a solution.

        • status — (String)

          The status of the solution update. A solution update can be in one of the following states:

          CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • performAutoTraining — (Boolean)

          Whether the solution automatically creates solution versions.

        • creationDateTime — (Date)

          The date and time (in Unix format) that the solution update was created.

        • lastUpdatedDateTime — (Date)

          The date and time (in Unix time) that the solution update was last updated.

        • failureReason — (String)

          If a solution update fails, the reason behind the failure.