Learn R Programming

paws (version 0.4.0)

personalize: Amazon Personalize

Description

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

Usage

personalize(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

    • endpoint: The complete URL to use for the constructed client.

    • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- personalize(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_batch_inference_jobCreates a batch inference job
create_batch_segment_jobCreates a batch segment job
create_campaignCreates a campaign that deploys a solution version
create_datasetCreates an empty dataset and adds it to the specified dataset group
create_dataset_export_jobCreates a job that exports data from your dataset to an Amazon S3 bucket
create_dataset_groupCreates an empty dataset group
create_dataset_import_jobCreates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset
create_event_trackerCreates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API
create_filterCreates a recommendation filter
create_metric_attributionCreates a metric attribution
create_recommenderCreates a recommender with the recipe (a Domain dataset group use case) you specify
create_schemaCreates an Amazon Personalize schema from the specified schema string
create_solutionCreates the configuration for training a model
create_solution_versionTrains or retrains an active solution in a Custom dataset group
delete_campaignRemoves a campaign by deleting the solution deployment
delete_datasetDeletes a dataset
delete_dataset_groupDeletes a dataset group
delete_event_trackerDeletes the event tracker
delete_filterDeletes a filter
delete_metric_attributionDeletes a metric attribution
delete_recommenderDeactivates and removes a recommender
delete_schemaDeletes a schema
delete_solutionDeletes all versions of a solution and the Solution object itself
describe_algorithmDescribes the given algorithm
describe_batch_inference_jobGets 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
describe_batch_segment_jobGets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments
describe_campaignDescribes the given campaign, including its status
describe_datasetDescribes the given dataset
describe_dataset_export_jobDescribes the dataset export job created by CreateDatasetExportJob, including the export job status
describe_dataset_groupDescribes the given dataset group
describe_dataset_import_jobDescribes the dataset import job created by CreateDatasetImportJob, including the import job status
describe_event_trackerDescribes an event tracker
describe_feature_transformationDescribes the given feature transformation
describe_filterDescribes a filter's properties
describe_metric_attributionDescribes a metric attribution
describe_recipeDescribes a recipe
describe_recommenderDescribes the given recommender, including its status
describe_schemaDescribes a schema
describe_solutionDescribes a solution
describe_solution_versionDescribes a specific version of a solution
get_solution_metricsGets the metrics for the specified solution version
list_batch_inference_jobsGets a list of the batch inference jobs that have been performed off of a solution version
list_batch_segment_jobsGets a list of the batch segment jobs that have been performed off of a solution version that you specify
list_campaignsReturns a list of campaigns that use the given solution
list_dataset_export_jobsReturns a list of dataset export jobs that use the given dataset
list_dataset_groupsReturns a list of dataset groups
list_dataset_import_jobsReturns a list of dataset import jobs that use the given dataset
list_datasetsReturns the list of datasets contained in the given dataset group
list_event_trackersReturns the list of event trackers associated with the account
list_filtersLists all filters that belong to a given dataset group
list_metric_attribution_metricsLists the metrics for the metric attribution
list_metric_attributionsLists metric attributions
list_recipesReturns a list of available recipes
list_recommendersReturns a list of recommenders in a given Domain dataset group
list_schemasReturns the list of schemas associated with the account
list_solutionsReturns a list of solutions that use the given dataset group
list_solution_versionsReturns a list of solution versions for the given solution
list_tags_for_resourceGet a list of tags attached to a resource
start_recommenderStarts a recommender that is INACTIVE
stop_recommenderStops a recommender that is ACTIVE
stop_solution_version_creationStops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS
tag_resourceAdd a list of tags to a resource
untag_resourceRemove tags that are attached to a resource
update_campaignUpdates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter
update_datasetUpdate a dataset to replace its schema with a new or existing one
update_metric_attributionUpdates a metric attribution
update_recommenderUpdates the recommender to modify the recommender configuration

Examples

Run this code
if (FALSE) {
svc <- personalize()
svc$create_batch_inference_job(
  Foo = 123
)
}

Run the code above in your browser using DataLab