@Generated(value="software.amazon.awssdk:codegen") public interface PersonalizeClient extends SdkClient
builder() method.
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PersonalizeClientBuilder |
builder()
Create a builder that can be used to configure and create a
PersonalizeClient. |
static PersonalizeClient |
create()
Create a
PersonalizeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateBatchInferenceJobResponse |
createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)
Creates a batch inference job.
|
default CreateBatchInferenceJobResponse |
createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
Creates a batch inference job.
|
default CreateCampaignResponse |
createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
Creates a campaign by deploying a solution version.
|
default CreateCampaignResponse |
createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a campaign by deploying a solution version.
|
default CreateDatasetResponse |
createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group.
|
default CreateDatasetResponse |
createDataset(CreateDatasetRequest createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group.
|
default CreateDatasetGroupResponse |
createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)
Creates an empty dataset group.
|
default CreateDatasetGroupResponse |
createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
Creates an empty dataset group.
|
default CreateDatasetImportJobResponse |
createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
dataset.
|
default CreateDatasetImportJobResponse |
createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
dataset.
|
default CreateEventTrackerResponse |
createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest)
Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.
|
default CreateEventTrackerResponse |
createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)
Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.
|
default CreateFilterResponse |
createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)
Creates a recommendation filter.
|
default CreateFilterResponse |
createFilter(CreateFilterRequest createFilterRequest)
Creates a recommendation filter.
|
default CreateSchemaResponse |
createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)
Creates an Amazon Personalize schema from the specified schema string.
|
default CreateSchemaResponse |
createSchema(CreateSchemaRequest createSchemaRequest)
Creates an Amazon Personalize schema from the specified schema string.
|
default CreateSolutionResponse |
createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)
Creates the configuration for training a model.
|
default CreateSolutionResponse |
createSolution(CreateSolutionRequest createSolutionRequest)
Creates the configuration for training a model.
|
default CreateSolutionVersionResponse |
createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)
Trains or retrains an active solution.
|
default CreateSolutionVersionResponse |
createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)
Trains or retrains an active solution.
|
default DeleteCampaignResponse |
deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)
Removes a campaign by deleting the solution deployment.
|
default DeleteCampaignResponse |
deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Removes a campaign by deleting the solution deployment.
|
default DeleteDatasetResponse |
deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes a dataset.
|
default DeleteDatasetResponse |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes a dataset.
|
default DeleteDatasetGroupResponse |
deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)
Deletes a dataset group.
|
default DeleteDatasetGroupResponse |
deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
Deletes a dataset group.
|
default DeleteEventTrackerResponse |
deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)
Deletes the event tracker.
|
default DeleteEventTrackerResponse |
deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)
Deletes the event tracker.
|
default DeleteFilterResponse |
deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)
Deletes a filter.
|
default DeleteFilterResponse |
deleteFilter(DeleteFilterRequest deleteFilterRequest)
Deletes a filter.
|
default DeleteSchemaResponse |
deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)
Deletes a schema.
|
default DeleteSchemaResponse |
deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a schema.
|
default DeleteSolutionResponse |
deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)
Deletes all versions of a solution and the
Solution object itself. |
default DeleteSolutionResponse |
deleteSolution(DeleteSolutionRequest deleteSolutionRequest)
Deletes all versions of a solution and the
Solution object itself. |
default DescribeAlgorithmResponse |
describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)
Describes the given algorithm.
|
default DescribeAlgorithmResponse |
describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
Describes the given algorithm.
|
default DescribeBatchInferenceJobResponse |
describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)
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.
|
default DescribeBatchInferenceJobResponse |
describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)
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.
|
default DescribeCampaignResponse |
describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the given campaign, including its status.
|
default DescribeCampaignResponse |
describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the given campaign, including its status.
|
default DescribeDatasetResponse |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Describes the given dataset.
|
default DescribeDatasetResponse |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Describes the given dataset.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)
Describes the given dataset group.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
Describes the given dataset group.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default DescribeEventTrackerResponse |
describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)
Describes an event tracker.
|
default DescribeEventTrackerResponse |
describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)
Describes an event tracker.
|
default DescribeFeatureTransformationResponse |
describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default DescribeFeatureTransformationResponse |
describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default DescribeFilterResponse |
describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)
Describes a filter's properties.
|
default DescribeFilterResponse |
describeFilter(DescribeFilterRequest describeFilterRequest)
Describes a filter's properties.
|
default DescribeRecipeResponse |
describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)
Describes a recipe.
|
default DescribeRecipeResponse |
describeRecipe(DescribeRecipeRequest describeRecipeRequest)
Describes a recipe.
|
default DescribeSchemaResponse |
describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)
Describes a schema.
|
default DescribeSchemaResponse |
describeSchema(DescribeSchemaRequest describeSchemaRequest)
Describes a schema.
|
default DescribeSolutionResponse |
describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)
Describes a solution.
|
default DescribeSolutionResponse |
describeSolution(DescribeSolutionRequest describeSolutionRequest)
Describes a solution.
|
default DescribeSolutionVersionResponse |
describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default DescribeSolutionVersionResponse |
describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default GetSolutionMetricsResponse |
getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default GetSolutionMetricsResponse |
getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default ListBatchInferenceJobsResponse |
listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsResponse |
listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsIterable |
listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsIterable |
listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListCampaignsResponse |
listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsResponse |
listCampaigns(ListCampaignsRequest listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsIterable |
listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsIterable |
listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListDatasetGroupsResponse |
listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetGroupsResponse |
listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetsResponse |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsResponse |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsIterable |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsIterable |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListEventTrackersResponse |
listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersResponse |
listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersIterable |
listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersIterable |
listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListFiltersResponse |
listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)
Lists all filters that belong to a given dataset group.
|
default ListFiltersResponse |
listFilters(ListFiltersRequest listFiltersRequest)
Lists all filters that belong to a given dataset group.
|
default ListRecipesResponse |
listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
Returns a list of available recipes.
|
default ListRecipesResponse |
listRecipes(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes.
|
default ListRecipesIterable |
listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
Returns a list of available recipes.
|
default ListRecipesIterable |
listRecipesPaginator(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes.
|
default ListSchemasResponse |
listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSchemasResponse |
listSchemas(ListSchemasRequest listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSchemasIterable |
listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSchemasIterable |
listSchemasPaginator(ListSchemasRequest listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSolutionsResponse |
listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsResponse |
listSolutions(ListSolutionsRequest listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsIterable |
listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsIterable |
listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionVersionsResponse |
listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsResponse |
listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsIterable |
listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsIterable |
listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateCampaignResponse |
updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
default UpdateCampaignResponse |
updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
serviceNameclosestatic final String SERVICE_NAME
static PersonalizeClient create()
PersonalizeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PersonalizeClientBuilder builder()
PersonalizeClient.default CreateBatchInferenceJobResponse createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
createBatchInferenceJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBatchInferenceJobResponse createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the CreateBatchInferenceJobRequest.Builder avoiding
the need to create one manually via CreateBatchInferenceJobRequest.builder()
createBatchInferenceJobRequest - A Consumer that will call methods on CreateBatchInferenceJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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, to maintain a 70% utilization. There's a short time delay while the capacity is
increased that might cause loss of transactions. It's recommended to start 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
createCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCampaignResponse createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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, to maintain a 70% utilization. There's a short time delay while the capacity is
increased that might cause loss of transactions. It's recommended to start 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
This is a convenience which creates an instance of the CreateCampaignRequest.Builder avoiding the need to
create one manually via CreateCampaignRequest.builder()
createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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
createDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
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 AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
createDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
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 AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
This is a convenience which creates an instance of the CreateDatasetGroupRequest.Builder avoiding the
need to create one manually via CreateDatasetGroupRequest.builder()
createDatasetGroupRequest - A Consumer that will call methods on CreateDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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 AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.
The dataset import job replaces any previous data in the dataset.
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
createDatasetImportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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 AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.
The dataset import job replaces any previous data in the dataset.
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
This is a convenience which creates an instance of the CreateDatasetImportJobRequest.Builder avoiding the
need to create one manually via CreateDatasetImportJobRequest.builder()
createDatasetImportJobRequest - A Consumer that will call methods on CreateDatasetImportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventTrackerResponse createEventTracker(CreateEventTrackerRequest createEventTrackerRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.
When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the
dataset group associated with the event tracker. The event-interactions dataset stores the event data from the
PutEvents call. The contents of this dataset are not available to the user.
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 send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data.
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
createEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventTrackerResponse createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.
When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the
dataset group associated with the event tracker. The event-interactions dataset stores the event data from the
PutEvents call. The contents of this dataset are not available to the user.
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 send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data.
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
This is a convenience which creates an instance of the CreateEventTrackerRequest.Builder avoiding the
need to create one manually via CreateEventTrackerRequest.builder()
createEventTrackerRequest - A Consumer that will call methods on CreateEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFilterResponse createFilter(CreateFilterRequest createFilterRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.
createFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFilterResponse createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.
This is a convenience which creates an instance of the CreateFilterRequest.Builder avoiding the need to
create one manually via CreateFilterRequest.builder()
createFilterRequest - A Consumer that will call methods on CreateFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSchemaResponse createSchema(CreateSchemaRequest createSchemaRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
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
createSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSchemaResponse createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
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
This is a convenience which creates an instance of the CreateSchemaRequest.Builder avoiding the need to
create one manually via CreateSchemaRequest.builder()
createSchemaRequest - A Consumer that will call methods on CreateSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSolutionResponse createSolution(CreateSolutionRequest createSolutionRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
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
createSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSolutionResponse createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
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
This is a convenience which creates an instance of the CreateSolutionRequest.Builder avoiding the need to
create one manually via CreateSolutionRequest.builder()
createSolutionRequest - A Consumer that will call methods on CreateSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSolutionVersionResponse createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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 -or- CREATE FAILED
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
createSolutionVersionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSolutionVersionResponse createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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 -or- CREATE FAILED
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
This is a convenience which creates an instance of the CreateSolutionVersionRequest.Builder avoiding the
need to create one manually via CreateSolutionVersionRequest.builder()
createSolutionVersionRequest - A Consumer that will call methods on CreateSolutionVersionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
deleteCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCampaignResponse deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DeleteCampaignRequest.Builder avoiding the need to
create one manually via DeleteCampaignRequest.builder()
deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
deleteDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to
create one manually via DeleteDatasetRequest.builder()
deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
deleteDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DeleteDatasetGroupRequest.Builder avoiding the
need to create one manually via DeleteDatasetGroupRequest.builder()
deleteDatasetGroupRequest - A Consumer that will call methods on DeleteDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventTrackerResponse deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
deleteEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventTrackerResponse deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
This is a convenience which creates an instance of the DeleteEventTrackerRequest.Builder avoiding the
need to create one manually via DeleteEventTrackerRequest.builder()
deleteEventTrackerRequest - A Consumer that will call methods on DeleteEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFilterResponse deleteFilter(DeleteFilterRequest deleteFilterRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a filter.
deleteFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFilterResponse deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a filter.
This is a convenience which creates an instance of the DeleteFilterRequest.Builder avoiding the need to
create one manually via DeleteFilterRequest.builder()
deleteFilterRequest - A Consumer that will call methods on DeleteFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSchemaResponse deleteSchema(DeleteSchemaRequest deleteSchemaRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSchemaResponse deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
This is a convenience which creates an instance of the DeleteSchemaRequest.Builder avoiding the need to
create one manually via DeleteSchemaRequest.builder()
deleteSchemaRequest - A Consumer that will call methods on DeleteSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSolutionResponse deleteSolution(DeleteSolutionRequest deleteSolutionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
deleteSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSolutionResponse deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DeleteSolutionRequest.Builder avoiding the need to
create one manually via DeleteSolutionRequest.builder()
deleteSolutionRequest - A Consumer that will call methods on DeleteSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAlgorithmResponse describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given algorithm.
describeAlgorithmRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAlgorithmResponse describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given algorithm.
This is a convenience which creates an instance of the DescribeAlgorithmRequest.Builder avoiding the need
to create one manually via DescribeAlgorithmRequest.builder()
describeAlgorithmRequest - A Consumer that will call methods on DescribeAlgorithmRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBatchInferenceJobResponse describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
describeBatchInferenceJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBatchInferenceJobResponse describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DescribeBatchInferenceJobRequest.Builder avoiding
the need to create one manually via DescribeBatchInferenceJobRequest.builder()
describeBatchInferenceJobRequest - A Consumer that will call methods on DescribeBatchInferenceJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCampaignResponse describeCampaign(DescribeCampaignRequest describeCampaignRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
describeCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCampaignResponse describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DescribeCampaignRequest.Builder avoiding the need
to create one manually via DescribeCampaignRequest.builder()
describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset. For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need
to create one manually via DescribeDatasetRequest.builder()
describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
This is a convenience which creates an instance of the DescribeDatasetGroupRequest.Builder avoiding the
need to create one manually via DescribeDatasetGroupRequest.builder()
describeDatasetGroupRequest - A Consumer that will call methods on DescribeDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
This is a convenience which creates an instance of the DescribeDatasetImportJobRequest.Builder avoiding
the need to create one manually via DescribeDatasetImportJobRequest.builder()
describeDatasetImportJobRequest - A Consumer that will call methods on DescribeDatasetImportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventTrackerResponse describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes an event tracker. The response includes the trackingId and status of the
event tracker. For more information on event trackers, see CreateEventTracker.
describeEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventTrackerResponse describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes an event tracker. The response includes the trackingId and status of the
event tracker. For more information on event trackers, see CreateEventTracker.
This is a convenience which creates an instance of the DescribeEventTrackerRequest.Builder avoiding the
need to create one manually via DescribeEventTrackerRequest.builder()
describeEventTrackerRequest - A Consumer that will call methods on DescribeEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFeatureTransformationResponse describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given feature transformation.
describeFeatureTransformationRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFeatureTransformationResponse describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given feature transformation.
This is a convenience which creates an instance of the DescribeFeatureTransformationRequest.Builder
avoiding the need to create one manually via DescribeFeatureTransformationRequest.builder()
describeFeatureTransformationRequest - A Consumer that will call methods on DescribeFeatureTransformationRequest.Builder to
create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFilterResponse describeFilter(DescribeFilterRequest describeFilterRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a filter's properties.
describeFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFilterResponse describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a filter's properties.
This is a convenience which creates an instance of the DescribeFilterRequest.Builder avoiding the need to
create one manually via DescribeFilterRequest.builder()
describeFilterRequest - A Consumer that will call methods on DescribeFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRecipeResponse describeRecipe(DescribeRecipeRequest describeRecipeRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
describeRecipeRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRecipeResponse describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the DescribeRecipeRequest.Builder avoiding the need to
create one manually via DescribeRecipeRequest.builder()
describeRecipeRequest - A Consumer that will call methods on DescribeRecipeRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSchemaResponse describeSchema(DescribeSchemaRequest describeSchemaRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a schema. For more information on schemas, see CreateSchema.
describeSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSchemaResponse describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a schema. For more information on schemas, see CreateSchema.
This is a convenience which creates an instance of the DescribeSchemaRequest.Builder avoiding the need to
create one manually via DescribeSchemaRequest.builder()
describeSchemaRequest - A Consumer that will call methods on DescribeSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionResponse describeSolution(DescribeSolutionRequest describeSolutionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionResponse describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a solution. For more information on solutions, see CreateSolution.
This is a convenience which creates an instance of the DescribeSolutionRequest.Builder avoiding the need
to create one manually via DescribeSolutionRequest.builder()
describeSolutionRequest - A Consumer that will call methods on DescribeSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionVersionResponse describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a specific version of a solution. For more information on solutions, see CreateSolution.
describeSolutionVersionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionVersionResponse describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a specific version of a solution. For more information on solutions, see CreateSolution.
This is a convenience which creates an instance of the DescribeSolutionVersionRequest.Builder avoiding
the need to create one manually via DescribeSolutionVersionRequest.builder()
describeSolutionVersionRequest - A Consumer that will call methods on DescribeSolutionVersionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSolutionMetricsResponse getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Gets the metrics for the specified solution version.
getSolutionMetricsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSolutionMetricsResponse getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Gets the metrics for the specified solution version.
This is a convenience which creates an instance of the GetSolutionMetricsRequest.Builder avoiding the
need to create one manually via GetSolutionMetricsRequest.builder()
getSolutionMetricsRequest - A Consumer that will call methods on GetSolutionMetricsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsResponse listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Gets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsResponse listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Gets a list of the batch inference jobs that have been performed off of a solution version.
This is a convenience which creates an instance of the ListBatchInferenceJobsRequest.Builder avoiding the
need to create one manually via ListBatchInferenceJobsRequest.builder()
listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Gets a list of the batch inference jobs that have been performed off of a solution version.
This is a variant of
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client
.listBatchInferenceJobsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation.
listBatchInferenceJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Gets a list of the batch inference jobs that have been performed off of a solution version.
This is a variant of
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client
.listBatchInferenceJobsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation.
This is a convenience which creates an instance of the ListBatchInferenceJobsRequest.Builder avoiding the
need to create one manually via ListBatchInferenceJobsRequest.builder()
listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsResponse listCampaigns(ListCampaignsRequest listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listCampaignsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsResponse listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListCampaignsRequest.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client
.listCampaignsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.
listCampaignsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client
.listCampaignsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.
This is a convenience which creates an instance of the ListCampaignsRequest.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listDatasetImportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation.
listDatasetImportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listDatasetsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.
listDatasetsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersResponse listEventTrackers(ListEventTrackersRequest listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listEventTrackersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersResponse listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListEventTrackersRequest.Builder avoiding the need
to create one manually via ListEventTrackersRequest.builder()
listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersIterable listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client
.listEventTrackersPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation.
listEventTrackersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersIterable listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client
.listEventTrackersPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation.
This is a convenience which creates an instance of the ListEventTrackersRequest.Builder avoiding the need
to create one manually via ListEventTrackersRequest.builder()
listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFiltersResponse listFilters(ListFiltersRequest listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists all filters that belong to a given dataset group.
listFiltersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFiltersResponse listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists all filters that belong to a given dataset group.
This is a convenience which creates an instance of the ListFiltersRequest.Builder avoiding the need to
create one manually via ListFiltersRequest.builder()
listFiltersRequest - A Consumer that will call methods on ListFiltersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesResponse listRecipes(ListRecipesRequest listRecipesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesResponse listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListRecipesRequest.Builder avoiding the need to
create one manually via ListRecipesRequest.builder()
listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesIterable listRecipesPaginator(ListRecipesRequest listRecipesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListRecipesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.
listRecipesRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesIterable listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListRecipesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.
This is a convenience which creates an instance of the ListRecipesRequest.Builder avoiding the need to
create one manually via ListRecipesRequest.builder()
listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasResponse listSchemas(ListSchemasRequest listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listSchemasRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasResponse listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListSchemasRequest.Builder avoiding the need to
create one manually via ListSchemasRequest.builder()
listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasIterable listSchemasPaginator(ListSchemasRequest listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSchemasResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.
listSchemasRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasIterable listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSchemasResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.
This is a convenience which creates an instance of the ListSchemasRequest.Builder avoiding the need to
create one manually via ListSchemasRequest.builder()
listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsResponse listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listSolutionVersionsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsResponse listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListSolutionVersionsRequest.Builder avoiding the
need to create one manually via ListSolutionVersionsRequest.builder()
listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsIterable listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client
.listSolutionVersionsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation.
listSolutionVersionsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsIterable listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client
.listSolutionVersionsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation.
This is a convenience which creates an instance of the ListSolutionVersionsRequest.Builder avoiding the
need to create one manually via ListSolutionVersionsRequest.builder()
listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsResponse listSolutions(ListSolutionsRequest listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
listSolutionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsResponse listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the ListSolutionsRequest.Builder avoiding the need to
create one manually via ListSolutionsRequest.builder()
listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsIterable listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client
.listSolutionsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.
listSolutionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsIterable listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a variant of
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client
.listSolutionsPaginator(request);
for (software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.
This is a convenience which creates an instance of the ListSolutionsRequest.Builder avoiding the need to
create one manually via ListSolutionsRequest.builder()
listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCampaignResponse updateCampaign(UpdateCampaignRequest updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
updateCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCampaignResponse updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
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.
This is a convenience which creates an instance of the UpdateCampaignRequest.Builder avoiding the need to
create one manually via UpdateCampaignRequest.builder()
updateCampaignRequest - A Consumer that will call methods on UpdateCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.