You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Personalize

Inherits:
AWS.Service show all
Identifier:
personalize
API Version:
2018-05-22
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Sending a Request Using Personalize

var personalize = new AWS.Personalize();
personalize.createBatchInferenceJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Personalize object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var personalize = new AWS.Personalize({apiVersion: '2018-05-22'});

You can also set the API version globally in AWS.config.apiVersions using the personalize service identifier:

AWS.config.apiVersions = {
  personalize: '2018-05-22',
  // other service API versions
};

var personalize = new AWS.Personalize();

Version:

  • 2018-05-22

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Personalize(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Personalize object

var personalize = new AWS.Personalize({apiVersion: '2018-05-22'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Personalize.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Personalize.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Personalize.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createBatchInferenceJob(params = {}, callback) ⇒ AWS.Request

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

Service Reference:

Examples:

Calling the createBatchInferenceJob operation

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 */
  batchInferenceJobConfig: {
    itemExplorationConfig: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    }
  },
  filterArn: 'STRING_VALUE',
  numResults: 'NUMBER_VALUE'
};
personalize.createBatchInferenceJob(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 inference job to create.

    • solutionVersionArn — (String)

      The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

    • filterArn — (String)

      The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering Batch Recommendations..

    • numResults — (Integer)

      The number of recommendations to retreive.

    • jobInput — (map)

      The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

      • 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 of a batch inference job.

    • jobOutput — (map)

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

      • 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 of a batch inference job.

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

    • batchInferenceJobConfig — (map)

      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.

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:

      • batchInferenceJobArn — (String)

        The ARN of the batch inference job.

Returns:

  • (AWS.Request) —

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

createCampaign(params = {}, callback) ⇒ AWS.Request

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Note: Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

Service Reference:

Examples:

Calling the createCampaign operation

var params = {
  name: 'STRING_VALUE', /* required */
  solutionVersionArn: 'STRING_VALUE', /* required */
  campaignConfig: {
    itemExplorationConfig: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    }
  },
  minProvisionedTPS: 'NUMBER_VALUE'
};
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 solution version to deploy.

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

        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. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

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.

createDataset(params = {}, callback) ⇒ AWS.Request

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  datasetType: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  schemaArn: 'STRING_VALUE' /* required */
};
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

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.

createDatasetExportJob(params = {}, callback) ⇒ AWS.Request

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

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

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

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Service Reference:

Examples:

Calling the createDatasetExportJob operation

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
};
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 of a batch inference 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:

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

createDatasetGroup(params = {}, callback) ⇒ AWS.Request

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

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

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

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

Note: You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

Related APIs

Service Reference:

Examples:

Calling the createDatasetGroup operation

var params = {
  name: 'STRING_VALUE', /* required */
  kmsKeyArn: 'STRING_VALUE',
  roleArn: 'STRING_VALUE'
};
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.

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.

Returns:

  • (AWS.Request) —

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

createDatasetImportJob(params = {}, callback) ⇒ AWS.Request

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

The dataset import job replaces any existing data in the dataset that you imported in bulk.

Status

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

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

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Note: Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

Service Reference:

Examples:

Calling the createDatasetImportJob operation

var params = {
  dataSource: { /* required */
    dataLocation: 'STRING_VALUE'
  },
  datasetArn: 'STRING_VALUE', /* required */
  jobName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE' /* required */
};
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)

        The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

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

    • roleArn — (String)

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

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.

createEventTracker(params = {}, callback) ⇒ AWS.Request

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Note: Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

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

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

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

Note: The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

Service Reference:

Examples:

Calling the createEventTracker operation

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
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.

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.

createFilter(params = {}, callback) ⇒ AWS.Request

Creates a recommendation filter. For more information, see filter.

Service Reference:

Examples:

Calling the createFilter operation

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  filterExpression: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
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.

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.

createSchema(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

Service Reference:

Examples:

Calling the createSchema operation

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

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.

createSolution(params = {}, callback) ⇒ AWS.Request

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Note: Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

Service Reference:

Examples:

Calling the createSolution operation

var params = {
  datasetGroupArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  eventType: 'STRING_VALUE',
  performAutoML: true || false,
  performHPO: true || false,
  recipeArn: 'STRING_VALUE',
  solutionConfig: {
    algorithmHyperParameters: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    },
    autoMLConfig: {
      metricName: 'STRING_VALUE',
      recipeList: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    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
    }
  }
};
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)

      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.

    • recipeArn — (String)

      The ARN of the recipe to use for model training. Only specified when performAutoML is false.

    • 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 to use with 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 hyperparameter names and ranges.

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

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.

createSolutionVersion(params = {}, callback) ⇒ AWS.Request

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

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

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

  • CREATE STOPPING

  • CREATE STOPPED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

Service Reference:

Examples:

Calling the createSolutionVersion operation

var params = {
  solutionArn: 'STRING_VALUE', /* required */
  trainingMode: FULL | UPDATE
};
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: {}) —
    • 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 FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

      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 HRNN-Coldstart recipe.

       Possible values include:
      • "FULL"
      • "UPDATE"

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.

deleteCampaign(params = {}, callback) ⇒ AWS.Request

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

Service Reference:

Examples:

Calling the deleteCampaign operation

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.

deleteDataset(params = {}, callback) ⇒ AWS.Request

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

Service Reference:

Examples:

Calling the deleteDataset operation

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.

deleteDatasetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

Service Reference:

Examples:

Calling the deleteDatasetGroup operation

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.

deleteEventTracker(params = {}, callback) ⇒ AWS.Request

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

Service Reference:

Examples:

Calling the deleteEventTracker operation

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.

deleteFilter(params = {}, callback) ⇒ AWS.Request

Deletes a filter.

Service Reference:

Examples:

Calling the deleteFilter operation

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.

deleteSchema(params = {}, callback) ⇒ AWS.Request

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

Service Reference:

Examples:

Calling the deleteSchema operation

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.

deleteSolution(params = {}, callback) ⇒ AWS.Request

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

Service Reference:

Examples:

Calling the deleteSolution operation

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.

describeAlgorithm(params = {}, callback) ⇒ AWS.Request

Describes the given algorithm.

Service Reference:

Examples:

Calling the describeAlgorithm operation

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.

describeBatchInferenceJob(params = {}, callback) ⇒ AWS.Request

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

Service Reference:

Examples:

Calling the describeBatchInferenceJob operation

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 of a batch inference job.

        • 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 of a batch inference job.

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

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

describeCampaign(params = {}, callback) ⇒ AWS.Request

Describes the given campaign, including its status.

A campaign can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

Service Reference:

Examples:

Calling the describeCampaign operation

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 a specific version of the solution.

        • minProvisionedTPS — (Integer)

          Specifies the requested minimum provisioned transactions (recommendations) per second.

        • campaignConfig — (map)

          The configuration details of a campaign.

          • 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. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

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

              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. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

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

describeDataset(params = {}, callback) ⇒ AWS.Request

Describes the given dataset. For more information on datasets, see CreateDataset.

Service Reference:

Examples:

Calling the describeDataset operation

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

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

Returns:

  • (AWS.Request) —

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

describeDatasetExportJob(params = {}, callback) ⇒ AWS.Request

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

Service Reference:

Examples:

Calling the describeDatasetExportJob operation

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 of a batch inference job.

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

describeDatasetGroup(params = {}, callback) ⇒ AWS.Request

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Service Reference:

Examples:

Calling the describeDatasetGroup operation

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 IAM role that has permissions to create the dataset group.

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

Returns:

  • (AWS.Request) —

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

describeDatasetImportJob(params = {}, callback) ⇒ AWS.Request

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

Service Reference:

Examples:

Calling the describeDatasetImportJob operation

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)

            The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

            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.

Returns:

  • (AWS.Request) —

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

describeEventTracker(params = {}, callback) ⇒ AWS.Request

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

Service Reference:

Examples:

Calling the describeEventTracker operation

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.

describeFeatureTransformation(params = {}, callback) ⇒ AWS.Request

Describes the given feature transformation.

Service Reference:

Examples:

Calling the describeFeatureTransformation operation

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.

describeFilter(params = {}, callback) ⇒ AWS.Request

Describes a filter's properties.

Service Reference:

Examples:

Calling the describeFilter operation

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.

describeRecipe(params = {}, callback) ⇒ AWS.Request

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

Service Reference:

Examples:

Calling the describeRecipe operation

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.

describeSchema(params = {}, callback) ⇒ AWS.Request

Describes a schema. For more information on schemas, see CreateSchema.

Service Reference:

Examples:

Calling the describeSchema operation

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.

Returns:

  • (AWS.Request) —

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

describeSolution(params = {}, callback) ⇒ AWS.Request

Describes a solution. For more information on solutions, see CreateSolution.

Service Reference:

Examples:

Calling the describeSolution operation

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)

          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.

        • recipeArn — (String)

          The ARN of the recipe used to create the solution.

        • 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 hyperparameter names and ranges.

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

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

Returns:

  • (AWS.Request) —

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

describeSolutionVersion(params = {}, callback) ⇒ AWS.Request

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

Service Reference:

Examples:

Calling the describeSolutionVersion operation

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

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

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:

      • solutionVersion — (map)

        The solution version.

        • solutionVersionArn — (String)

          The ARN of the solution version.

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

          When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

        • recipeArn — (String)

          The ARN of the recipe used in the solution.

        • eventType — (String)

          The event type (for example, 'click' or 'like') that is used for training the model.

        • datasetGroupArn — (String)

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

        • 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 hyperparameter names and ranges.

          • 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"
        • trainingHours — (Float)

          The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

        • trainingMode — (String)

          The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

          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 HRNN-Coldstart recipe.

           Possible values include:
          • "FULL"
          • "UPDATE"
        • tunedHPOParams — (map)

          If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

          • algorithmHyperParameters — (map<String>)

            A list of the hyperparameter values of the best performing model.

        • 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

          • CREATE FAILED

          • CREATE STOPPING

          • CREATE STOPPED

        • failureReason — (String)

          If training a solution version fails, the reason for the failure.

        • creationDateTime — (Date)

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

        • lastUpdatedDateTime — (Date)

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

Returns:

  • (AWS.Request) —

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

getSolutionMetrics(params = {}, callback) ⇒ AWS.Request

Gets the metrics for the specified solution version.

Service Reference:

Examples:

Calling the getSolutionMetrics operation

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

      The Amazon Resource Name (ARN) of the solution version for which to get metrics.

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 same solution version ARN as specified in the request.

      • metrics — (map<Float>)

        The metrics for the solution version.

Returns:

  • (AWS.Request) —

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

listBatchInferenceJobs(params = {}, callback) ⇒ AWS.Request

Gets a list of the batch inference jobs that have been performed off of a solution version.

Service Reference:

Examples:

Calling the listBatchInferenceJobs operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  solutionVersionArn: 'STRING_VALUE'
};
personalize.listBatchInferenceJobs(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: {}) —
    • solutionVersionArn — (String)

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

    • nextToken — (String)

      The token to request the next page of results.

    • maxResults — (Integer)

      The maximum number of batch inference job results to return in each page. The default value is 100.

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:

      • batchInferenceJobs — (Array<map>)

        A list containing information on each job that is returned.

        • batchInferenceJobArn — (String)

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

        • jobName — (String)

          The name of the batch inference job.

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

        • failureReason — (String)

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

        • solutionVersionArn — (String)

          The ARN of the solution version used by the batch inference job.

      • nextToken — (String)

        The token to use to retrieve the next page of results. The value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

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

listCampaigns(params = {}, callback) ⇒ AWS.Request

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

Service Reference:

Examples:

Calling the listCampaigns operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  solutionArn: 'STRING_VALUE'
};
personalize.listCampaigns(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 list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

    • nextToken — (String)

      A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

    • maxResults — (Integer)

      The maximum number of campaigns to return.

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:

      • campaigns — (Array<map>)

        A list of the campaigns.

        • name — (String)

          The name of the campaign.

        • campaignArn — (String)

          The Amazon Resource Name (ARN) of the campaign.

        • 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

        • creationDateTime — (Date)

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

        • lastUpdatedDateTime — (Date)

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

        • failureReason — (String)

          If a campaign fails, the reason behind the failure.

      • nextToken — (String)

        A token for getting the next set of campaigns (if they exist).

Returns:

  • (AWS.Request) —

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

listDatasetExportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

Service Reference:

Examples:

Calling the listDatasetExportJobs operation

var params = {
  datasetArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listDatasetExportJobs(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 list the dataset export jobs for.

    • nextToken — (String)

      A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

    • maxResults — (Integer)

      The maximum number of dataset export jobs to return.

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:

      • datasetExportJobs — (Array<map>)

        The list of dataset export jobs.

        • datasetExportJobArn — (String)

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

        • jobName — (String)

          The name of the dataset export job.

        • 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

        • creationDateTime — (Date)

          The date and time (in Unix time) that the dataset export job was created.

        • lastUpdatedDateTime — (Date)

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

        • failureReason — (String)

          If a dataset export job fails, the reason behind the failure.

      • nextToken — (String)

        A token for getting the next set of dataset export jobs (if they exist).

Returns:

  • (AWS.Request) —

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

listDatasetGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

Service Reference:

Examples:

Calling the listDatasetGroups operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listDatasetGroups(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: {}) —
    • nextToken — (String)

      A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

    • maxResults — (Integer)

      The maximum number of dataset groups to return.

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:

      • datasetGroups — (Array<map>)

        The list of your dataset groups.

        • name — (String)

          The name of the dataset group.

        • datasetGroupArn — (String)

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

        • status — (String)

          The 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

        • creationDateTime — (Date)

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

        • lastUpdatedDateTime — (Date)

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

        • failureReason — (String)

          If creating a dataset group fails, the reason behind the failure.

      • nextToken — (String)

        A token for getting the next set of dataset groups (if they exist).

Returns:

  • (AWS.Request) —

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

listDatasetImportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

Service Reference:

Examples:

Calling the listDatasetImportJobs operation

var params = {
  datasetArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listDatasetImportJobs(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 list the dataset import jobs for.

    • nextToken — (String)

      A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

    • maxResults — (Integer)

      The maximum number of dataset import jobs to return.

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:

      • datasetImportJobs — (Array<map>)

        The list of dataset import jobs.

        • datasetImportJobArn — (String)

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

        • jobName — (String)

          The name of the dataset import job.

        • 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 date and time (in Unix time) that the dataset import job was created.

        • lastUpdatedDateTime — (Date)

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

        • failureReason — (String)

          If a dataset import job fails, the reason behind the failure.

      • nextToken — (String)

        A token for getting the next set of dataset import jobs (if they exist).

Returns:

  • (AWS.Request) —

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

listDatasets(params = {}, callback) ⇒ AWS.Request

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

Service Reference:

Examples:

Calling the listDatasets operation

var params = {
  datasetGroupArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listDatasets(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 that contains the datasets to list.

    • nextToken — (String)

      A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

    • maxResults — (Integer)

      The maximum number of datasets to return.

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:

      • datasets — (Array<map>)

        An array of Dataset objects. Each object provides metadata information.

        • name — (String)

          The name of the dataset.

        • datasetArn — (String)

          The Amazon Resource Name (ARN) of the dataset.

        • datasetType — (String)

          The dataset type. One of the following values:

          • Interactions

          • Items

          • Users

          • Event-Interactions

        • 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 date and time (in Unix time) that the dataset was created.

        • lastUpdatedDateTime — (Date)

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

      • nextToken — (String)

        A token for getting the next set of datasets (if they exist).

Returns:

  • (AWS.Request) —

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

listEventTrackers(params = {}, callback) ⇒ AWS.Request

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

Service Reference:

Examples:

Calling the listEventTrackers operation

var params = {
  datasetGroupArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listEventTrackers(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 a dataset group used to filter the response.

    • nextToken — (String)

      A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

    • maxResults — (Integer)

      The maximum number of event trackers to return.

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:

      • eventTrackers — (Array<map>)

        A list of event trackers.

        • name — (String)

          The name of the event tracker.

        • eventTrackerArn — (String)

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

        • 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 time) that the event tracker was created.

        • lastUpdatedDateTime — (Date)

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

      • nextToken — (String)

        A token for getting the next set of event trackers (if they exist).

Returns:

  • (AWS.Request) —

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

listFilters(params = {}, callback) ⇒ AWS.Request

Lists all filters that belong to a given dataset group.

Service Reference:

Examples:

Calling the listFilters operation

var params = {
  datasetGroupArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listFilters(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 that contains the filters.

    • nextToken — (String)

      A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

    • maxResults — (Integer)

      The maximum number of filters to return.

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:

      • Filters — (Array<map>)

        A list of returned filters.

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

        • status — (String)

          The status of the filter.

      • nextToken — (String)

        A token for getting the next set of filters (if they exist).

Returns:

  • (AWS.Request) —

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

listRecipes(params = {}, callback) ⇒ AWS.Request

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the listRecipes operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  recipeProvider: SERVICE
};
personalize.listRecipes(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: {}) —
    • recipeProvider — (String)

      The default is SERVICE.

      Possible values include:
      • "SERVICE"
    • nextToken — (String)

      A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

    • maxResults — (Integer)

      The maximum number of recipes to return.

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:

      • recipes — (Array<map>)

        The list of available recipes.

        • name — (String)

          The name of the recipe.

        • recipeArn — (String)

          The Amazon Resource Name (ARN) of the recipe.

        • status — (String)

          The status of the recipe.

        • creationDateTime — (Date)

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

        • lastUpdatedDateTime — (Date)

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

      • nextToken — (String)

        A token for getting the next set of recipes.

Returns:

  • (AWS.Request) —

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

listSchemas(params = {}, callback) ⇒ AWS.Request

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

Service Reference:

Examples:

Calling the listSchemas operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listSchemas(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: {}) —
    • nextToken — (String)

      A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

    • maxResults — (Integer)

      The maximum number of schemas to return.

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:

      • schemas — (Array<map>)

        A list of schemas.

        • name — (String)

          The name of the schema.

        • schemaArn — (String)

          The Amazon Resource Name (ARN) of 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.

      • nextToken — (String)

        A token used to get the next set of schemas (if they exist).

Returns:

  • (AWS.Request) —

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

listSolutions(params = {}, callback) ⇒ AWS.Request

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Service Reference:

Examples:

Calling the listSolutions operation

var params = {
  datasetGroupArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
personalize.listSolutions(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.

    • nextToken — (String)

      A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

    • maxResults — (Integer)

      The maximum number of solutions to return.

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:

      • solutions — (Array<map>)

        A list of the current solutions.

        • name — (String)

          The name of the solution.

        • solutionArn — (String)

          The Amazon Resource Name (ARN) of the solution.

        • 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 date and time (in Unix time) that the solution was created.

        • lastUpdatedDateTime — (Date)

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

      • nextToken — (String)

        A token for getting the next set of solutions (if they exist).

Returns:

  • (AWS.Request) —

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

listSolutionVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Service Reference:

Examples:

Calling the listSolutionVersions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  solutionArn: 'STRING_VALUE'
};
personalize.listSolutionVersions(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.

    • nextToken — (String)

      A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

    • maxResults — (Integer)

      The maximum number of solution versions to return.

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:

      • solutionVersions — (Array<map>)

        A list of solution versions describing the version properties.

        • 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

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

      • nextToken — (String)

        A token for getting the next set of solution versions (if they exist).

Returns:

  • (AWS.Request) —

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

stopSolutionVersionCreation(params = {}, callback) ⇒ AWS.Request

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

  • CREATE_PENDING > CREATE_STOPPED

    or

  • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

Service Reference:

Examples:

Calling the stopSolutionVersionCreation operation

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

      The Amazon Resource Name (ARN) of the solution version you want to stop creating.

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.

updateCampaign(params = {}, callback) ⇒ AWS.Request

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

Note: You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

Service Reference:

Examples:

Calling the updateCampaign operation

var params = {
  campaignArn: 'STRING_VALUE', /* required */
  campaignConfig: {
    itemExplorationConfig: {
      '<ParameterName>': 'STRING_VALUE',
      /* '<ParameterName>': ... */
    }
  },
  minProvisionedTPS: 'NUMBER_VALUE',
  solutionVersionArn: 'STRING_VALUE'
};
personalize.updateCampaign(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.

    • solutionVersionArn — (String)

      The ARN of a new solution version to deploy.

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

        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. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

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 same campaign ARN as given in the request.

Returns:

  • (AWS.Request) —

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