Class: Aws::Personalize::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb

Overview

An API client for Personalize. To construct a client, you need to configure a :region and :credentials.

client = Aws::Personalize::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



343
344
345
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 343

def initialize(*args)
  super
end

Instance Method Details

#create_batch_inference_job(params = {}) ⇒ Types::CreateBatchInferenceJobResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_batch_inference_job({
  job_name: "Name", # required
  solution_version_arn: "Arn", # required
  filter_arn: "Arn",
  num_results: 1,
  job_input: { # required
    s3_data_source: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
  job_output: { # required
    s3_data_destination: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
  role_arn: "RoleArn", # required
  batch_inference_job_config: {
    item_exploration_config: {
      "ParameterName" => "ParameterValue",
    },
  },
})

Response structure


resp.batch_inference_job_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_name (required, String)

    The name of the batch inference job to create.

  • :solution_version_arn (required, String)

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

  • :filter_arn (String)

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

  • :num_results (Integer)

    The number of recommendations to retreive.

  • :job_input (required, Types::BatchInferenceJobInput)

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

  • :job_output (required, Types::BatchInferenceJobOutput)

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

  • :role_arn (required, 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.

  • :batch_inference_job_config (Types::BatchInferenceJobConfig)

    The configuration details of a batch inference job.

Returns:

See Also:



427
428
429
430
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 427

def create_batch_inference_job(params = {}, options = {})
  req = build_request(:create_batch_inference_job, params)
  req.send_request(options)
end

#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse

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.

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

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

Examples:

Request syntax with placeholder values


resp = client.create_campaign({
  name: "Name", # required
  solution_version_arn: "Arn", # required
  min_provisioned_tps: 1,
  campaign_config: {
    item_exploration_config: {
      "ParameterName" => "ParameterValue",
    },
  },
})

Response structure


resp.campaign_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

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

  • :solution_version_arn (required, String)

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

  • :min_provisioned_tps (Integer)

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

  • :campaign_config (Types::CampaignConfig)

    The configuration details of a campaign.

Returns:

See Also:



526
527
528
529
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 526

def create_campaign(params = {}, options = {})
  req = build_request(:create_campaign, params)
  req.send_request(options)
end

#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

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

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

Examples:

Request syntax with placeholder values


resp = client.create_dataset({
  name: "Name", # required
  schema_arn: "Arn", # required
  dataset_group_arn: "Arn", # required
  dataset_type: "DatasetType", # required
})

Response structure


resp.dataset_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name for the dataset.

  • :schema_arn (required, String)

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

  • :dataset_group_arn (required, String)

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

  • :dataset_type (required, String)

    The type of dataset.

    One of the following (case insensitive) values:

    • Interactions

    • Items

    • Users

Returns:

See Also:



608
609
610
611
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 608

def create_dataset(params = {}, options = {})
  req = build_request(:create_dataset, params)
  req.send_request(options)
end

#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_dataset_export_job({
  job_name: "Name", # required
  dataset_arn: "Arn", # required
  ingestion_mode: "BULK", # accepts BULK, PUT, ALL
  role_arn: "RoleArn", # required
  job_output: { # required
    s3_data_destination: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
})

Response structure


resp.dataset_export_job_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_name (required, String)

    The name for the dataset export job.

  • :dataset_arn (required, String)

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

  • :ingestion_mode (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.

  • :role_arn (required, String)

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

  • :job_output (required, Types::DatasetExportJobOutput)

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

Returns:

See Also:



687
688
689
690
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 687

def create_dataset_export_job(params = {}, options = {})
  req = build_request(:create_dataset_export_job, params)
  req.send_request(options)
end

#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse

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.

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

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

Examples:

Request syntax with placeholder values


resp = client.create_dataset_group({
  name: "Name", # required
  role_arn: "RoleArn",
  kms_key_arn: "KmsKeyArn",
})

Response structure


resp.dataset_group_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name for the new dataset group.

  • :role_arn (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.

  • :kms_key_arn (String)

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

Returns:

See Also:



775
776
777
778
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 775

def create_dataset_group(params = {}, options = {})
  req = build_request(:create_dataset_group, params)
  req.send_request(options)
end

#create_dataset_import_job(params = {}) ⇒ Types::CreateDatasetImportJobResponse

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.

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

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

Examples:

Request syntax with placeholder values


resp = client.create_dataset_import_job({
  job_name: "Name", # required
  dataset_arn: "Arn", # required
  data_source: { # required
    data_location: "S3Location",
  },
  role_arn: "RoleArn", # required
})

Response structure


resp.dataset_import_job_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_name (required, String)

    The name for the dataset import job.

  • :dataset_arn (required, String)

    The ARN of the dataset that receives the imported data.

  • :data_source (required, Types::DataSource)

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

  • :role_arn (required, String)

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

Returns:

See Also:



858
859
860
861
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 858

def create_dataset_import_job(params = {}, options = {})
  req = build_request(:create_dataset_import_job, params)
  req.send_request(options)
end

#create_event_tracker(params = {}) ⇒ Types::CreateEventTrackerResponse

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

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.

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

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

Examples:

Request syntax with placeholder values


resp = client.create_event_tracker({
  name: "Name", # required
  dataset_group_arn: "Arn", # required
})

Response structure


resp.event_tracker_arn #=> String
resp.tracking_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name for the event tracker.

  • :dataset_group_arn (required, String)

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

Returns:

See Also:



932
933
934
935
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 932

def create_event_tracker(params = {}, options = {})
  req = build_request(:create_event_tracker, params)
  req.send_request(options)
end

#create_filter(params = {}) ⇒ Types::CreateFilterResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_filter({
  name: "Name", # required
  dataset_group_arn: "Arn", # required
  filter_expression: "FilterExpression", # required
})

Response structure


resp.filter_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the filter to create.

  • :dataset_group_arn (required, String)

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

  • :filter_expression (required, 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.

Returns:

See Also:



971
972
973
974
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 971

def create_filter(params = {}, options = {})
  req = build_request(:create_filter, params)
  req.send_request(options)
end

#create_schema(params = {}) ⇒ Types::CreateSchemaResponse

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

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

Examples:

Request syntax with placeholder values


resp = client.create_schema({
  name: "Name", # required
  schema: "AvroSchema", # required
})

Response structure


resp.schema_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name for the schema.

  • :schema (required, String)

    A schema in Avro JSON format.

Returns:

See Also:



1016
1017
1018
1019
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1016

def create_schema(params = {}, options = {})
  req = build_request(:create_schema, params)
  req.send_request(options)
end

#create_solution(params = {}) ⇒ Types::CreateSolutionResponse

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.

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

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution ^

  • ListSolutionVersions

  • DescribeSolutionVersion

Examples:

Request syntax with placeholder values


resp = client.create_solution({
  name: "Name", # required
  perform_hpo: false,
  perform_auto_ml: false,
  recipe_arn: "Arn",
  dataset_group_arn: "Arn", # required
  event_type: "EventType",
  solution_config: {
    event_value_threshold: "EventValueThreshold",
    hpo_config: {
      hpo_objective: {
        type: "HPOObjectiveType",
        metric_name: "MetricName",
        metric_regex: "MetricRegex",
      },
      hpo_resource_config: {
        max_number_of_training_jobs: "HPOResource",
        max_parallel_training_jobs: "HPOResource",
      },
      algorithm_hyper_parameter_ranges: {
        integer_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            min_value: 1,
            max_value: 1,
          },
        ],
        continuous_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            min_value: 1.0,
            max_value: 1.0,
          },
        ],
        categorical_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            values: ["CategoricalValue"],
          },
        ],
      },
    },
    algorithm_hyper_parameters: {
      "ParameterName" => "ParameterValue",
    },
    feature_transformation_parameters: {
      "ParameterName" => "ParameterValue",
    },
    auto_ml_config: {
      metric_name: "MetricName",
      recipe_list: ["Arn"],
    },
    optimization_objective: {
      item_attribute: "ItemAttribute",
      objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
    },
  },
})

Response structure


resp.solution_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name for the solution.

  • :perform_hpo (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.

  • :perform_auto_ml (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.

  • :recipe_arn (String)

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

  • :dataset_group_arn (required, String)

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

  • :event_type (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.

  • :solution_config (Types::SolutionConfig)

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

    Amazon Personalize doesn't support configuring the hpoObjective at this time.

Returns:

See Also:



1196
1197
1198
1199
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1196

def create_solution(params = {}, options = {})
  req = build_request(:create_solution, params)
  req.send_request(options)
end

#create_solution_version(params = {}) ⇒ Types::CreateSolutionVersionResponse

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

  • ListSolutionVersions

  • DescribeSolutionVersion ^

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

Examples:

Request syntax with placeholder values


resp = client.create_solution_version({
  solution_arn: "Arn", # required
  training_mode: "FULL", # accepts FULL, UPDATE
})

Response structure


resp.solution_version_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_arn (required, String)

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

  • :training_mode (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.

Returns:

See Also:



1284
1285
1286
1287
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1284

def create_solution_version(params = {}, options = {})
  req = build_request(:create_solution_version, params)
  req.send_request(options)
end

#delete_campaign(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_campaign({
  campaign_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :campaign_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1314
1315
1316
1317
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1314

def delete_campaign(params = {}, options = {})
  req = build_request(:delete_campaign, params)
  req.send_request(options)
end

#delete_dataset(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset({
  dataset_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1338
1339
1340
1341
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1338

def delete_dataset(params = {}, options = {})
  req = build_request(:delete_dataset, params)
  req.send_request(options)
end

#delete_dataset_group(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset_group({
  dataset_group_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (required, String)

    The ARN of the dataset group to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1367
1368
1369
1370
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1367

def delete_dataset_group(params = {}, options = {})
  req = build_request(:delete_dataset_group, params)
  req.send_request(options)
end

#delete_event_tracker(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_event_tracker({
  event_tracker_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :event_tracker_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1391
1392
1393
1394
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1391

def delete_event_tracker(params = {}, options = {})
  req = build_request(:delete_event_tracker, params)
  req.send_request(options)
end

#delete_filter(params = {}) ⇒ Struct

Deletes a filter.

Examples:

Request syntax with placeholder values


resp = client.delete_filter({
  filter_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter_arn (required, String)

    The ARN of the filter to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1413
1414
1415
1416
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1413

def delete_filter(params = {}, options = {})
  req = build_request(:delete_filter, params)
  req.send_request(options)
end

#delete_schema(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_schema({
  schema_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :schema_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1437
1438
1439
1440
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1437

def delete_schema(params = {}, options = {})
  req = build_request(:delete_schema, params)
  req.send_request(options)
end

#delete_solution(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_solution({
  solution_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_arn (required, String)

    The ARN of the solution to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1465
1466
1467
1468
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1465

def delete_solution(params = {}, options = {})
  req = build_request(:delete_solution, params)
  req.send_request(options)
end

#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmResponse

Describes the given algorithm.

Examples:

Request syntax with placeholder values


resp = client.describe_algorithm({
  algorithm_arn: "Arn", # required
})

Response structure


resp.algorithm.name #=> String
resp.algorithm.algorithm_arn #=> String
resp.algorithm.algorithm_image.name #=> String
resp.algorithm.algorithm_image.docker_uri #=> String
resp.algorithm.default_hyper_parameters #=> Hash
resp.algorithm.default_hyper_parameters["ParameterName"] #=> String
resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].is_tunable #=> Boolean
resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].is_tunable #=> Boolean
resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].is_tunable #=> Boolean
resp.algorithm.default_resource_config #=> Hash
resp.algorithm.default_resource_config["ParameterName"] #=> String
resp.algorithm.training_input_mode #=> String
resp.algorithm.role_arn #=> String
resp.algorithm.creation_date_time #=> Time
resp.algorithm.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :algorithm_arn (required, String)

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

Returns:

See Also:



1519
1520
1521
1522
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1519

def describe_algorithm(params = {}, options = {})
  req = build_request(:describe_algorithm, params)
  req.send_request(options)
end

#describe_batch_inference_job(params = {}) ⇒ Types::DescribeBatchInferenceJobResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_batch_inference_job({
  batch_inference_job_arn: "Arn", # required
})

Response structure


resp.batch_inference_job.job_name #=> String
resp.batch_inference_job.batch_inference_job_arn #=> String
resp.batch_inference_job.filter_arn #=> String
resp.batch_inference_job.failure_reason #=> String
resp.batch_inference_job.solution_version_arn #=> String
resp.batch_inference_job.num_results #=> Integer
resp.batch_inference_job.job_input.s3_data_source.path #=> String
resp.batch_inference_job.job_input.s3_data_source.kms_key_arn #=> String
resp.batch_inference_job.job_output.s3_data_destination.path #=> String
resp.batch_inference_job.job_output.s3_data_destination.kms_key_arn #=> String
resp.batch_inference_job.batch_inference_job_config.item_exploration_config #=> Hash
resp.batch_inference_job.batch_inference_job_config.item_exploration_config["ParameterName"] #=> String
resp.batch_inference_job.role_arn #=> String
resp.batch_inference_job.status #=> String
resp.batch_inference_job.creation_date_time #=> Time
resp.batch_inference_job.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :batch_inference_job_arn (required, String)

    The ARN of the batch inference job to describe.

Returns:

See Also:



1564
1565
1566
1567
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1564

def describe_batch_inference_job(params = {}, options = {})
  req = build_request(:describe_batch_inference_job, params)
  req.send_request(options)
end

#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_campaign({
  campaign_arn: "Arn", # required
})

Response structure


resp.campaign.name #=> String
resp.campaign.campaign_arn #=> String
resp.campaign.solution_version_arn #=> String
resp.campaign.min_provisioned_tps #=> Integer
resp.campaign.campaign_config.item_exploration_config #=> Hash
resp.campaign.campaign_config.item_exploration_config["ParameterName"] #=> String
resp.campaign.status #=> String
resp.campaign.failure_reason #=> String
resp.campaign.creation_date_time #=> Time
resp.campaign.last_updated_date_time #=> Time
resp.campaign.latest_campaign_update.solution_version_arn #=> String
resp.campaign.latest_campaign_update.min_provisioned_tps #=> Integer
resp.campaign.latest_campaign_update.campaign_config.item_exploration_config #=> Hash
resp.campaign.latest_campaign_update.campaign_config.item_exploration_config["ParameterName"] #=> String
resp.campaign.latest_campaign_update.status #=> String
resp.campaign.latest_campaign_update.failure_reason #=> String
resp.campaign.latest_campaign_update.creation_date_time #=> Time
resp.campaign.latest_campaign_update.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :campaign_arn (required, String)

    The Amazon Resource Name (ARN) of the campaign.

Returns:

See Also:



1621
1622
1623
1624
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1621

def describe_campaign(params = {}, options = {})
  req = build_request(:describe_campaign, params)
  req.send_request(options)
end

#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_dataset({
  dataset_arn: "Arn", # required
})

Response structure


resp.dataset.name #=> String
resp.dataset.dataset_arn #=> String
resp.dataset.dataset_group_arn #=> String
resp.dataset.dataset_type #=> String
resp.dataset.schema_arn #=> String
resp.dataset.status #=> String
resp.dataset.creation_date_time #=> Time
resp.dataset.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_arn (required, String)

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

Returns:

See Also:



1657
1658
1659
1660
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1657

def describe_dataset(params = {}, options = {})
  req = build_request(:describe_dataset, params)
  req.send_request(options)
end

#describe_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_dataset_export_job({
  dataset_export_job_arn: "Arn", # required
})

Response structure


resp.dataset_export_job.job_name #=> String
resp.dataset_export_job.dataset_export_job_arn #=> String
resp.dataset_export_job.dataset_arn #=> String
resp.dataset_export_job.ingestion_mode #=> String, one of "BULK", "PUT", "ALL"
resp.dataset_export_job.role_arn #=> String
resp.dataset_export_job.status #=> String
resp.dataset_export_job.job_output.s3_data_destination.path #=> String
resp.dataset_export_job.job_output.s3_data_destination.kms_key_arn #=> String
resp.dataset_export_job.creation_date_time #=> Time
resp.dataset_export_job.last_updated_date_time #=> Time
resp.dataset_export_job.failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_export_job_arn (required, String)

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

Returns:

See Also:



1696
1697
1698
1699
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1696

def describe_dataset_export_job(params = {}, options = {})
  req = build_request(:describe_dataset_export_job, params)
  req.send_request(options)
end

#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_dataset_group({
  dataset_group_arn: "Arn", # required
})

Response structure


resp.dataset_group.name #=> String
resp.dataset_group.dataset_group_arn #=> String
resp.dataset_group.status #=> String
resp.dataset_group.role_arn #=> String
resp.dataset_group.kms_key_arn #=> String
resp.dataset_group.creation_date_time #=> Time
resp.dataset_group.last_updated_date_time #=> Time
resp.dataset_group.failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (required, String)

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

Returns:

See Also:



1732
1733
1734
1735
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1732

def describe_dataset_group(params = {}, options = {})
  req = build_request(:describe_dataset_group, params)
  req.send_request(options)
end

#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_dataset_import_job({
  dataset_import_job_arn: "Arn", # required
})

Response structure


resp.dataset_import_job.job_name #=> String
resp.dataset_import_job.dataset_import_job_arn #=> String
resp.dataset_import_job.dataset_arn #=> String
resp.dataset_import_job.data_source.data_location #=> String
resp.dataset_import_job.role_arn #=> String
resp.dataset_import_job.status #=> String
resp.dataset_import_job.creation_date_time #=> Time
resp.dataset_import_job.last_updated_date_time #=> Time
resp.dataset_import_job.failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_import_job_arn (required, String)

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

Returns:

See Also:



1769
1770
1771
1772
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1769

def describe_dataset_import_job(params = {}, options = {})
  req = build_request(:describe_dataset_import_job, params)
  req.send_request(options)
end

#describe_event_tracker(params = {}) ⇒ Types::DescribeEventTrackerResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_event_tracker({
  event_tracker_arn: "Arn", # required
})

Response structure


resp.event_tracker.name #=> String
resp.event_tracker.event_tracker_arn #=> String
resp.event_tracker. #=> String
resp.event_tracker.tracking_id #=> String
resp.event_tracker.dataset_group_arn #=> String
resp.event_tracker.status #=> String
resp.event_tracker.creation_date_time #=> Time
resp.event_tracker.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :event_tracker_arn (required, String)

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

Returns:

See Also:



1806
1807
1808
1809
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1806

def describe_event_tracker(params = {}, options = {})
  req = build_request(:describe_event_tracker, params)
  req.send_request(options)
end

#describe_feature_transformation(params = {}) ⇒ Types::DescribeFeatureTransformationResponse

Describes the given feature transformation.

Examples:

Request syntax with placeholder values


resp = client.describe_feature_transformation({
  feature_transformation_arn: "Arn", # required
})

Response structure


resp.feature_transformation.name #=> String
resp.feature_transformation.feature_transformation_arn #=> String
resp.feature_transformation.default_parameters #=> Hash
resp.feature_transformation.default_parameters["ParameterName"] #=> String
resp.feature_transformation.creation_date_time #=> Time
resp.feature_transformation.last_updated_date_time #=> Time
resp.feature_transformation.status #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :feature_transformation_arn (required, String)

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

Returns:

See Also:



1841
1842
1843
1844
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1841

def describe_feature_transformation(params = {}, options = {})
  req = build_request(:describe_feature_transformation, params)
  req.send_request(options)
end

#describe_filter(params = {}) ⇒ Types::DescribeFilterResponse

Describes a filter's properties.

Examples:

Request syntax with placeholder values


resp = client.describe_filter({
  filter_arn: "Arn", # required
})

Response structure


resp.data.filter.name #=> String
resp.data.filter.filter_arn #=> String
resp.data.filter.creation_date_time #=> Time
resp.data.filter.last_updated_date_time #=> Time
resp.data.filter.dataset_group_arn #=> String
resp.data.filter.failure_reason #=> String
resp.data.filter.filter_expression #=> String
resp.data.filter.status #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filter_arn (required, String)

    The ARN of the filter to describe.

Returns:

See Also:



1876
1877
1878
1879
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1876

def describe_filter(params = {}, options = {})
  req = build_request(:describe_filter, params)
  req.send_request(options)
end

#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_recipe({
  recipe_arn: "Arn", # required
})

Response structure


resp.recipe.name #=> String
resp.recipe.recipe_arn #=> String
resp.recipe.algorithm_arn #=> String
resp.recipe.feature_transformation_arn #=> String
resp.recipe.status #=> String
resp.recipe.description #=> String
resp.recipe.creation_date_time #=> Time
resp.recipe.recipe_type #=> String
resp.recipe.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recipe_arn (required, String)

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

Returns:

See Also:



1932
1933
1934
1935
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1932

def describe_recipe(params = {}, options = {})
  req = build_request(:describe_recipe, params)
  req.send_request(options)
end

#describe_schema(params = {}) ⇒ Types::DescribeSchemaResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_schema({
  schema_arn: "Arn", # required
})

Response structure


resp.schema.name #=> String
resp.schema.schema_arn #=> String
resp.schema.schema #=> String
resp.schema.creation_date_time #=> Time
resp.schema.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :schema_arn (required, String)

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

Returns:

See Also:



1964
1965
1966
1967
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1964

def describe_schema(params = {}, options = {})
  req = build_request(:describe_schema, params)
  req.send_request(options)
end

#describe_solution(params = {}) ⇒ Types::DescribeSolutionResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_solution({
  solution_arn: "Arn", # required
})

Response structure


resp.solution.name #=> String
resp.solution.solution_arn #=> String
resp.solution.perform_hpo #=> Boolean
resp.solution.perform_auto_ml #=> Boolean
resp.solution.recipe_arn #=> String
resp.solution.dataset_group_arn #=> String
resp.solution.event_type #=> String
resp.solution.solution_config.event_value_threshold #=> String
resp.solution.solution_config.hpo_config.hpo_objective.type #=> String
resp.solution.solution_config.hpo_config.hpo_objective.metric_name #=> String
resp.solution.solution_config.hpo_config.hpo_objective.metric_regex #=> String
resp.solution.solution_config.hpo_config.hpo_resource_config.max_number_of_training_jobs #=> String
resp.solution.solution_config.hpo_config.hpo_resource_config.max_parallel_training_jobs #=> String
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
resp.solution.solution_config.algorithm_hyper_parameters #=> Hash
resp.solution.solution_config.algorithm_hyper_parameters["ParameterName"] #=> String
resp.solution.solution_config.feature_transformation_parameters #=> Hash
resp.solution.solution_config.feature_transformation_parameters["ParameterName"] #=> String
resp.solution.solution_config.auto_ml_config.metric_name #=> String
resp.solution.solution_config.auto_ml_config.recipe_list #=> Array
resp.solution.solution_config.auto_ml_config.recipe_list[0] #=> String
resp.solution.solution_config.optimization_objective.item_attribute #=> String
resp.solution.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
resp.solution.auto_ml_result.best_recipe_arn #=> String
resp.solution.status #=> String
resp.solution.creation_date_time #=> Time
resp.solution.last_updated_date_time #=> Time
resp.solution.latest_solution_version.solution_version_arn #=> String
resp.solution.latest_solution_version.status #=> String
resp.solution.latest_solution_version.creation_date_time #=> Time
resp.solution.latest_solution_version.last_updated_date_time #=> Time
resp.solution.latest_solution_version.failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_arn (required, String)

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

Returns:

See Also:



2035
2036
2037
2038
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2035

def describe_solution(params = {}, options = {})
  req = build_request(:describe_solution, params)
  req.send_request(options)
end

#describe_solution_version(params = {}) ⇒ Types::DescribeSolutionVersionResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_solution_version({
  solution_version_arn: "Arn", # required
})

Response structure


resp.solution_version.solution_version_arn #=> String
resp.solution_version.solution_arn #=> String
resp.solution_version.perform_hpo #=> Boolean
resp.solution_version.perform_auto_ml #=> Boolean
resp.solution_version.recipe_arn #=> String
resp.solution_version.event_type #=> String
resp.solution_version.dataset_group_arn #=> String
resp.solution_version.solution_config.event_value_threshold #=> String
resp.solution_version.solution_config.hpo_config.hpo_objective.type #=> String
resp.solution_version.solution_config.hpo_config.hpo_objective.metric_name #=> String
resp.solution_version.solution_config.hpo_config.hpo_objective.metric_regex #=> String
resp.solution_version.solution_config.hpo_config.hpo_resource_config.max_number_of_training_jobs #=> String
resp.solution_version.solution_config.hpo_config.hpo_resource_config.max_parallel_training_jobs #=> String
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
resp.solution_version.solution_config.algorithm_hyper_parameters #=> Hash
resp.solution_version.solution_config.algorithm_hyper_parameters["ParameterName"] #=> String
resp.solution_version.solution_config.feature_transformation_parameters #=> Hash
resp.solution_version.solution_config.feature_transformation_parameters["ParameterName"] #=> String
resp.solution_version.solution_config.auto_ml_config.metric_name #=> String
resp.solution_version.solution_config.auto_ml_config.recipe_list #=> Array
resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
resp.solution_version.solution_config.optimization_objective.item_attribute #=> String
resp.solution_version.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
resp.solution_version.training_hours #=> Float
resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE"
resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters #=> Hash
resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters["ParameterName"] #=> String
resp.solution_version.status #=> String
resp.solution_version.failure_reason #=> String
resp.solution_version.creation_date_time #=> Time
resp.solution_version.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_version_arn (required, String)

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

Returns:

See Also:



2105
2106
2107
2108
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2105

def describe_solution_version(params = {}, options = {})
  req = build_request(:describe_solution_version, params)
  req.send_request(options)
end

#get_solution_metrics(params = {}) ⇒ Types::GetSolutionMetricsResponse

Gets the metrics for the specified solution version.

Examples:

Request syntax with placeholder values


resp = client.get_solution_metrics({
  solution_version_arn: "Arn", # required
})

Response structure


resp.solution_version_arn #=> String
resp.metrics #=> Hash
resp.metrics["MetricName"] #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_version_arn (required, String)

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

Returns:

See Also:



2137
2138
2139
2140
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2137

def get_solution_metrics(params = {}, options = {})
  req = build_request(:get_solution_metrics, params)
  req.send_request(options)
end

#list_batch_inference_jobs(params = {}) ⇒ Types::ListBatchInferenceJobsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_batch_inference_jobs({
  solution_version_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.batch_inference_jobs #=> Array
resp.batch_inference_jobs[0].batch_inference_job_arn #=> String
resp.batch_inference_jobs[0].job_name #=> String
resp.batch_inference_jobs[0].status #=> String
resp.batch_inference_jobs[0].creation_date_time #=> Time
resp.batch_inference_jobs[0].last_updated_date_time #=> Time
resp.batch_inference_jobs[0].failure_reason #=> String
resp.batch_inference_jobs[0].solution_version_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_version_arn (String)

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

  • :next_token (String)

    The token to request the next page of results.

  • :max_results (Integer)

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

Returns:

See Also:



2187
2188
2189
2190
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2187

def list_batch_inference_jobs(params = {}, options = {})
  req = build_request(:list_batch_inference_jobs, params)
  req.send_request(options)
end

#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_campaigns({
  solution_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.campaigns #=> Array
resp.campaigns[0].name #=> String
resp.campaigns[0].campaign_arn #=> String
resp.campaigns[0].status #=> String
resp.campaigns[0].creation_date_time #=> Time
resp.campaigns[0].last_updated_date_time #=> Time
resp.campaigns[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_arn (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.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of campaigns to return.

Returns:

See Also:



2240
2241
2242
2243
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2240

def list_campaigns(params = {}, options = {})
  req = build_request(:list_campaigns, params)
  req.send_request(options)
end

#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_export_jobs({
  dataset_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.dataset_export_jobs #=> Array
resp.dataset_export_jobs[0].dataset_export_job_arn #=> String
resp.dataset_export_jobs[0].job_name #=> String
resp.dataset_export_jobs[0].status #=> String
resp.dataset_export_jobs[0].creation_date_time #=> Time
resp.dataset_export_jobs[0].last_updated_date_time #=> Time
resp.dataset_export_jobs[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_arn (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of dataset export jobs to return.

Returns:

See Also:



2293
2294
2295
2296
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2293

def list_dataset_export_jobs(params = {}, options = {})
  req = build_request(:list_dataset_export_jobs, params)
  req.send_request(options)
end

#list_dataset_groups(params = {}) ⇒ Types::ListDatasetGroupsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_groups({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.dataset_groups #=> Array
resp.dataset_groups[0].name #=> String
resp.dataset_groups[0].dataset_group_arn #=> String
resp.dataset_groups[0].status #=> String
resp.dataset_groups[0].creation_date_time #=> Time
resp.dataset_groups[0].last_updated_date_time #=> Time
resp.dataset_groups[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of dataset groups to return.

Returns:

See Also:



2338
2339
2340
2341
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2338

def list_dataset_groups(params = {}, options = {})
  req = build_request(:list_dataset_groups, params)
  req.send_request(options)
end

#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_import_jobs({
  dataset_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.dataset_import_jobs #=> Array
resp.dataset_import_jobs[0].dataset_import_job_arn #=> String
resp.dataset_import_jobs[0].job_name #=> String
resp.dataset_import_jobs[0].status #=> String
resp.dataset_import_jobs[0].creation_date_time #=> Time
resp.dataset_import_jobs[0].last_updated_date_time #=> Time
resp.dataset_import_jobs[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_arn (String)

    The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of dataset import jobs to return.

Returns:

See Also:



2391
2392
2393
2394
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2391

def list_dataset_import_jobs(params = {}, options = {})
  req = build_request(:list_dataset_import_jobs, params)
  req.send_request(options)
end

#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_datasets({
  dataset_group_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.datasets #=> Array
resp.datasets[0].name #=> String
resp.datasets[0].dataset_arn #=> String
resp.datasets[0].dataset_type #=> String
resp.datasets[0].status #=> String
resp.datasets[0].creation_date_time #=> Time
resp.datasets[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (String)

    The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of datasets to return.

Returns:

See Also:



2442
2443
2444
2445
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2442

def list_datasets(params = {}, options = {})
  req = build_request(:list_datasets, params)
  req.send_request(options)
end

#list_event_trackers(params = {}) ⇒ Types::ListEventTrackersResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_trackers({
  dataset_group_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.event_trackers #=> Array
resp.event_trackers[0].name #=> String
resp.event_trackers[0].event_tracker_arn #=> String
resp.event_trackers[0].status #=> String
resp.event_trackers[0].creation_date_time #=> Time
resp.event_trackers[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (String)

    The ARN of a dataset group used to filter the response.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of event trackers to return.

Returns:

See Also:



2491
2492
2493
2494
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2491

def list_event_trackers(params = {}, options = {})
  req = build_request(:list_event_trackers, params)
  req.send_request(options)
end

#list_filters(params = {}) ⇒ Types::ListFiltersResponse

Lists all filters that belong to a given dataset group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_filters({
  dataset_group_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.filters #=> Array
resp.filters[0].name #=> String
resp.filters[0].filter_arn #=> String
resp.filters[0].creation_date_time #=> Time
resp.filters[0].last_updated_date_time #=> Time
resp.filters[0].dataset_group_arn #=> String
resp.filters[0].failure_reason #=> String
resp.filters[0].status #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (String)

    The ARN of the dataset group that contains the filters.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of filters to return.

Returns:

See Also:



2539
2540
2541
2542
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2539

def list_filters(params = {}, options = {})
  req = build_request(:list_filters, params)
  req.send_request(options)
end

#list_recipes(params = {}) ⇒ Types::ListRecipesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recipes({
  recipe_provider: "SERVICE", # accepts SERVICE
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.recipes #=> Array
resp.recipes[0].name #=> String
resp.recipes[0].recipe_arn #=> String
resp.recipes[0].status #=> String
resp.recipes[0].creation_date_time #=> Time
resp.recipes[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recipe_provider (String)

    The default is SERVICE.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of recipes to return.

Returns:

See Also:



2587
2588
2589
2590
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2587

def list_recipes(params = {}, options = {})
  req = build_request(:list_recipes, params)
  req.send_request(options)
end

#list_schemas(params = {}) ⇒ Types::ListSchemasResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_schemas({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.schemas #=> Array
resp.schemas[0].name #=> String
resp.schemas[0].schema_arn #=> String
resp.schemas[0].creation_date_time #=> Time
resp.schemas[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of schemas to return.

Returns:

See Also:



2630
2631
2632
2633
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2630

def list_schemas(params = {}, options = {})
  req = build_request(:list_schemas, params)
  req.send_request(options)
end

#list_solution_versions(params = {}) ⇒ Types::ListSolutionVersionsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_solution_versions({
  solution_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.solution_versions #=> Array
resp.solution_versions[0].solution_version_arn #=> String
resp.solution_versions[0].status #=> String
resp.solution_versions[0].creation_date_time #=> Time
resp.solution_versions[0].last_updated_date_time #=> Time
resp.solution_versions[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_arn (String)

    The Amazon Resource Name (ARN) of the solution.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of solution versions to return.

Returns:

See Also:



2680
2681
2682
2683
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2680

def list_solution_versions(params = {}, options = {})
  req = build_request(:list_solution_versions, params)
  req.send_request(options)
end

#list_solutions(params = {}) ⇒ Types::ListSolutionsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_solutions({
  dataset_group_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.solutions #=> Array
resp.solutions[0].name #=> String
resp.solutions[0].solution_arn #=> String
resp.solutions[0].status #=> String
resp.solutions[0].creation_date_time #=> Time
resp.solutions[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :dataset_group_arn (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of solutions to return.

Returns:

See Also:



2730
2731
2732
2733
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2730

def list_solutions(params = {}, options = {})
  req = build_request(:list_solutions, params)
  req.send_request(options)
end

#stop_solution_version_creation(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.stop_solution_version_creation({
  solution_version_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :solution_version_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2767
2768
2769
2770
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2767

def stop_solution_version_creation(params = {}, options = {})
  req = build_request(:stop_solution_version_creation, params)
  req.send_request(options)
end

#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse

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.

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.

Examples:

Request syntax with placeholder values


resp = client.update_campaign({
  campaign_arn: "Arn", # required
  solution_version_arn: "Arn",
  min_provisioned_tps: 1,
  campaign_config: {
    item_exploration_config: {
      "ParameterName" => "ParameterValue",
    },
  },
})

Response structure


resp.campaign_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :campaign_arn (required, String)

    The Amazon Resource Name (ARN) of the campaign.

  • :solution_version_arn (String)

    The ARN of a new solution version to deploy.

  • :min_provisioned_tps (Integer)

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

  • :campaign_config (Types::CampaignConfig)

    The configuration details of a campaign.

Returns:

See Also:



2823
2824
2825
2826
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2823

def update_campaign(params = {}, options = {})
  req = build_request(:update_campaign, params)
  req.send_request(options)
end