AWS.Tools.Personalize.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Personalize</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PERS.AddPERSResourceTagCmdlet"> <summary> Add a list of tags to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.AddPERSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource's Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.AddPERSResourceTagCmdlet.Tag"> <summary> <para> <para>Tags to apply to the resource. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">Tagging Amazon Personalize resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.AddPERSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.AddPERSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSAlgorithmCmdlet"> <summary> Describes the given algorithm. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSAlgorithmCmdlet.AlgorithmArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the algorithm to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSAlgorithmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Algorithm'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeAlgorithmResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeAlgorithmResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobCmdlet.BatchInferenceJobArn"> <summary> <para> <para>The ARN of the batch inference job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchInferenceJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeBatchInferenceJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeBatchInferenceJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet"> <summary> Gets a list of the batch inference jobs that have been performed off of a solution version.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of batch inference job results to return in each page. The default value is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet.NextToken"> <summary> <para> <para>The token to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchInferenceJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListBatchInferenceJobsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListBatchInferenceJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchInferenceJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobCmdlet"> <summary> Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobCmdlet.BatchSegmentJobArn"> <summary> <para> <para>The ARN of the batch segment job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchSegmentJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeBatchSegmentJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeBatchSegmentJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet"> <summary> Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of batch segment job results to return in each page. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet.NextToken"> <summary> <para> <para>The token to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchSegmentJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListBatchSegmentJobsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListBatchSegmentJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSBatchSegmentJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignCmdlet"> <summary> Describes the given campaign, including its status. <para> A campaign can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> When the <c>status</c> is <c>CREATE FAILED</c>, the response includes the <c>failureReason</c> key, which describes why. </para><para> For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Campaign'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeCampaignResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of campaigns to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> for getting the next set of campaigns (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Campaigns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListCampaignsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListCampaignsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobCmdlet"> <summary> Describes the data deletion job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html">CreateDataDeletionJob</a>, including the job status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobCmdlet.DataDeletionJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the data deletion job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataDeletionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeDataDeletionJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeDataDeletionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet"> <summary> Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html">Deleting users</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of data deletion jobs to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListDataDeletionJobs</c> for getting the next set of jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataDeletionJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListDataDeletionJobsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListDataDeletionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDataDeletionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetCmdlet"> <summary> Describes the given dataset. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dataset'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobCmdlet"> <summary> Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>, including the export job status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobCmdlet.DatasetExportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset export job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetExportJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeDatasetExportJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeDatasetExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet"> <summary> Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of dataset export jobs to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListDatasetExportJobs</c> for getting the next set of dataset export jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetExportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListDatasetExportJobsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListDatasetExportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetExportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupCmdlet"> <summary> Describes the given dataset group. For more information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeDatasetGroupResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeDatasetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of dataset groups to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListDatasetGroups</c> for getting the next set of dataset groups (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListDatasetGroupsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListDatasetGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobCmdlet"> <summary> Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>, including the import job status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobCmdlet.DatasetImportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset import job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeDatasetImportJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeDatasetImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of dataset import jobs to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListDatasetImportJobs</c> for getting the next set of dataset import jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListDatasetImportJobsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListDatasetImportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of datasets to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListDatasets</c> for getting the next set of dataset import jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Datasets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListDatasetsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListDatasetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerCmdlet"> <summary> Describes an event tracker. The response includes the <c>trackingId</c> and <c>status</c> of the event tracker. For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerCmdlet.EventTrackerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the event tracker to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventTracker'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeEventTrackerResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeEventTrackerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of a dataset group used to filter the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of event trackers to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListEventTrackers</c> for getting the next set of event trackers (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventTrackers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListEventTrackersResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListEventTrackersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSFeatureTransformationCmdlet"> <summary> Describes the given feature transformation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFeatureTransformationCmdlet.FeatureTransformationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the feature transformation to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFeatureTransformationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeatureTransformation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeFeatureTransformationResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeFeatureTransformationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterCmdlet"> <summary> Describes a filter's properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Filter'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeFilterResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet"> <summary> Lists all filters that belong to a given dataset group.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of the dataset group that contains the filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of filters to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListFilters</c> for getting the next set of filters (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Filters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListFiltersResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListFiltersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFilterListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionCmdlet"> <summary> Describes a metric attribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionCmdlet.MetricAttributionArn"> <summary> <para> <para>The metric attribution's Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricAttribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeMetricAttributionResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeMetricAttributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet"> <summary> Lists metric attributions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet.DatasetGroupArn"> <summary> <para> <para>The metric attributions' dataset group Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of metric attributions to return in one page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet.NextToken"> <summary> <para> <para>Specify the pagination token from a previous request to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricAttributions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListMetricAttributionsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListMetricAttributionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet"> <summary> Lists the metrics for the metric attribution.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet.MetricAttributionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of metrics to return in one page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet.NextToken"> <summary> <para> <para>Specify the pagination token from a previous request to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Metrics'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListMetricAttributionMetricsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListMetricAttributionMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSMetricAttributionMetricListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeCmdlet"> <summary> Describes a recipe. <para> A recipe contains three items: </para><ul><li><para> An algorithm that trains a model. </para></li><li><para> Hyperparameters that govern the training. </para></li><li><para> Feature transformation information for modifying the input data before training. </para></li></ul><para> Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> API. <c>CreateSolution</c> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeCmdlet.RecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recipe to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Recipe'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeRecipeResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeRecipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet"> <summary> Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.Domain"> <summary> <para> <para> Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.RecipeProvider"> <summary> <para> <para>The default is <c>SERVICE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recipes to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListRecipes</c> for getting the next set of recipes (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Recipes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListRecipesResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListRecipesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderCmdlet"> <summary> Describes the given recommender, including its status. <para> A recommender can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> When the <c>status</c> is <c>CREATE FAILED</c>, the response includes the <c>failureReason</c> key, which describes why. </para><para> The <c>modelMetrics</c> key is null when the recommender is being created or deleted. </para><para> For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderCmdlet.RecommenderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Recommender'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeRecommenderResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeRecommenderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet"> <summary> Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommenders to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListRecommenders</c> for getting the next set of recommenders (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Recommenders'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListRecommendersResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListRecommendersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecommenderListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSResourceTagCmdlet"> <summary> Get a list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> attached to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource's Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaCmdlet"> <summary> Describes a schema. For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schema to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schema'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeSchemaResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of schemas to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListSchemas</c> for getting the next set of schemas (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListSchemasResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionCmdlet"> <summary> Describes a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Solution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeSolutionResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeSolutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet"> <summary> Returns a list of solutions in a 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of solutions to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListSolutions</c> for getting the next set of solutions (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Solutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListSolutionsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListSolutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionMetricCmdlet"> <summary> Gets the metrics for the specified solution version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionMetricCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version for which to get metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.GetSolutionMetricsResponse). Specifying the name of a property of type Amazon.Personalize.Model.GetSolutionMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionCmdlet"> <summary> Describes a specific version of a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SolutionVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DescribeSolutionVersionResponse). Specifying the name of a property of type Amazon.Personalize.Model.DescribeSolutionVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet"> <summary> 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).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of solution versions to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <c>ListSolutionVersions</c> for getting the next set of solution versions (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SolutionVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.ListSolutionVersionsResponse). Specifying the name of a property of type Amazon.Personalize.Model.ListSolutionVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet"> <summary> Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. <para> To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. </para><para> For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html">Creating a batch inference job </a>. </para><para> If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to <c>THEME_GENERATION</c> and specify the name of the field that contains item names in the input data. </para><para> For more information about generating themes, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html">Batch recommendations with themes from Content Generator </a>. </para><para> You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.BatchInferenceJobMode"> <summary> <para> <para>The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to <c>THEME_GENERATION</c>. If you don't want to generate themes, use the default <c>BATCH_INFERENCE</c>.</para><para> When you get batch recommendations with themes, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to apply to the batch inference job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.BatchInferenceJobConfig_ItemExplorationConfig"> <summary> <para> <para>A string to string map specifying the exploration configuration hyperparameters, including <c>explorationWeight</c> and <c>explorationItemAgeCutOff</c>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.FieldsForThemeGeneration_ItemName"> <summary> <para> <para>The name of the Items dataset column that stores the name of each item in the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.JobName"> <summary> <para> <para>The name of the batch inference job to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.S3DataSource_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.S3DataDestination_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.NumResult"> <summary> <para> <para>The number of recommendations to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.S3DataSource_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.S3DataDestination_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.RoleArn"> <summary> <para> <para>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch inference job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchInferenceJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateBatchInferenceJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateBatchInferenceJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchInferenceJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet"> <summary> Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to apply to the batch segment job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.JobName"> <summary> <para> <para>The name of the batch segment job to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.S3DataSource_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.S3DataDestination_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.NumResult"> <summary> <para> <para>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.S3DataSource_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.S3DataDestination_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.RoleArn"> <summary> <para> <para>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch segment job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BatchSegmentJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateBatchSegmentJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateBatchSegmentJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSBatchSegmentJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet"> <summary> <important><para> You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para></important><para> Creates a campaign that deploys a solution version. When a client calls the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> and <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a> APIs, a campaign is specified in the request. </para><para><b>Minimum Provisioned TPS and Auto-Scaling</b></para><important><para> A high <c>minProvisionedTPS</c> will increase your cost. We recommend starting with 1 for <c>minProvisionedTPS</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minProvisionedTPS</c> as necessary. </para></important><para> When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (<c>minProvisionedTPS</c>) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single <c>GetRecommendations</c> or <c>GetPersonalizedRanking</c> request. The default <c>minProvisionedTPS</c> is 1. </para><para> If your TPS increases beyond the <c>minProvisionedTPS</c>, Amazon Personalize auto-scales the provisioned capacity up and down, but never below <c>minProvisionedTPS</c>. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the <c>minProvisionedTPS</c>. </para><para> You are charged for the the minimum provisioned TPS or, if your requests exceed the <c>minProvisionedTPS</c>, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low <c>minProvisionedTPS</c>, track your usage using Amazon CloudWatch metrics, and then increase the <c>minProvisionedTPS</c> as necessary. </para><para> For more information about campaign costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para><para><b>Status</b></para><para> A campaign can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> To get the campaign status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>. </para><note><para> Wait until the <c>status</c> of the campaign is <c>ACTIVE</c> before asking the campaign for recommendations. </para></note><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html">UpdateCampaign</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html">DeleteCampaign</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.CampaignConfig_EnableMetadataWithRecommendation"> <summary> <para> <para>Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata">Enabling metadata in recommendations for a campaign</a>.</para><para> If you enable metadata in recommendations, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.CampaignConfig_ItemExplorationConfig"> <summary> <para> <para>Specifies the exploration configuration hyperparameters, including <c>explorationWeight</c> and <c>explorationItemAgeCutOff</c>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide <c>itemExplorationConfig</c> data only if your solution uses the <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a> recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.MinProvisionedTPS"> <summary> <para> <para>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high <c>minProvisionedTPS</c> will increase your bill. We recommend starting with 1 for <c>minProvisionedTPS</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minProvisionedTPS</c> as necessary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Name"> <summary> <para> <para>A name for the new campaign. The campaign name must be unique within your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your <i>solution</i> in <c>SolutionArn/$LATEST</c> format. You must use this format if you set <c>syncWithLatestSolutionVersion</c> to <c>True</c> in the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html">CampaignConfig</a>. </para><para> To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. </para><para> For more information about automatic campaign updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.CampaignConfig_SyncWithLatestSolutionVersion"> <summary> <para> <para>Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify <c>True</c>, you must specify the ARN of your <i>solution</i> for the <c>SolutionVersionArn</c> parameter. It must be in <c>SolutionArn/$LATEST</c> format. The default is <c>False</c> and you must manually update the campaign to deploy the latest solution version. </para><para> For more information about automatic campaign updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateCampaignResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet"> <summary> Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html">Deleting users</a>. <ul><li><para> Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html">Preparing your data deletion file and uploading it to Amazon S3</a>. </para></li><li><para> To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs <c>GetObject</c> and <c>ListBucket</c> permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize Access to Amazon S3 Resources</a>. </para></li></ul><para> After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments. </para><para><b>Status</b></para><para> A data deletion job can have one of the following statuses: </para><ul><li><para> PENDING > IN_PROGRESS > COMPLETED -or- FAILED </para></li></ul><para> To get the status of the data deletion job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html">DescribeDataDeletionJob</a> API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a <c>failureReason</c> key, which describes why the job failed. </para><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html">ListDataDeletionJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html">DescribeDataDeletionJob</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.DataSource_DataLocation"> <summary> <para> <para>For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. </para><para> For example: </para><para><c>s3://bucket-name/folder-name/fileName.csv</c></para><para>If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a <c>/</c> after the folder name:</para><para><c>s3://bucket-name/folder-name/</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.JobName"> <summary> <para> <para>The name for the data deletion job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the data deletion job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataDeletionJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDataDeletionJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateDataDeletionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDataDeletionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet"> <summary> Creates an empty dataset and adds it to the specified dataset group. Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a dataset. <para> There are 5 types of datasets: </para><ul><li><para> Item interactions </para></li><li><para> Items </para></li><li><para> Users </para></li><li><para> Action interactions </para></li><li><para> Actions </para></li></ul><para> Each dataset type has an associated schema with required field types. Only the <c>Item interactions</c> dataset is required in order to train a model (also referred to as creating a solution). </para><para> A dataset can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> To get the status of the dataset, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>. </para><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html">ListDatasets</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html">DeleteDataset</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to add the dataset to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.DatasetType"> <summary> <para> <para>The type of dataset.</para><para>One of the following (case insensitive) values:</para><ul><li><para>Interactions</para></li><li><para>Items</para></li><li><para>Users</para></li><li><para>Actions</para></li><li><para>Action_Interactions</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Name"> <summary> <para> <para>The name for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the schema to associate with the dataset. The schema defines the dataset fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet"> <summary> Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize <c>PutObject</c> permissions for your Amazon S3 bucket. For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a> in the Amazon Personalize developer guide. <para><b>Status</b></para><para> A dataset export job can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li></ul><para> To get the status of the export job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html">DescribeDatasetExportJob</a>, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <c>failureReason</c> key, which describes why the job failed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset that contains the data to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.IngestionMode"> <summary> <para> <para>The data to export, based on how you imported the data. You can choose to export only <c>BULK</c> data that you imported using a dataset import job, only <c>PUT</c> data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or <c>ALL</c> for both types. The default value is <c>PUT</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.JobName"> <summary> <para> <para>The name for the dataset export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.S3DataDestination_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.S3DataDestination_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetExportJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDatasetExportJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateDatasetExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetExportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet"> <summary> Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: <ul><li><para> Item interactions </para></li><li><para> Items </para></li><li><para> Users </para></li><li><para> Actions </para></li><li><para> Action interactions </para></li></ul><para> A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. </para><para> A dataset group can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING </para></li></ul><para> To get the status of the dataset group, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>. If the status shows as CREATE FAILED, the response includes a <c>failureReason</c> key, which describes why the creation failed. </para><note><para> You must wait until the <c>status</c> of the dataset group is <c>ACTIVE</c> before adding a dataset to the group. </para></note><para> You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. </para><para><b>APIs that require a dataset group ARN in the request</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a></para></li></ul><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html">DeleteDatasetGroup</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Domain"> <summary> <para> <para>The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Name"> <summary> <para> <para>The name for the new dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.RoleArn"> <summary> <para> <para>The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDatasetGroupResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateDatasetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet"> <summary> Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize Access to Amazon S3 Resources</a>. <para> If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html">How new data influences real-time recommendations</a>. </para><important><para> By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. </para></important><para><b>Status</b></para><para> A dataset import job can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li></ul><para> To get the status of the import job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>, 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 <c>failureReason</c> key, which describes why the job failed. </para><note><para> Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. </para></note><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.DataSource_DataLocation"> <summary> <para> <para>For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. </para><para> For example: </para><para><c>s3://bucket-name/folder-name/fileName.csv</c></para><para>If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a <c>/</c> after the folder name:</para><para><c>s3://bucket-name/folder-name/</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.DatasetArn"> <summary> <para> <para>The ARN of the dataset that receives the imported data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.ImportMode"> <summary> <para> <para>Specify how to add the new records to an existing dataset. The default import mode is <c>FULL</c>. If you haven't imported bulk records into the dataset previously, you can only specify <c>FULL</c>.</para><ul><li><para>Specify <c>FULL</c> to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.</para></li><li><para>Specify <c>INCREMENTAL</c> to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.JobName"> <summary> <para> <para>The name for the dataset import job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.PublishAttributionMetricsToS3"> <summary> <para> <para>If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.RoleArn"> <summary> <para> <para>The ARN of the IAM role that has permissions to read from the Amazon S3 data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset import job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDatasetImportJobResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateDatasetImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet"> <summary> Creates an event tracker that you use when adding event data to a specified dataset group using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API. <note><para> Only one event tracker can be associated with a dataset group. You will get an error if you call <c>CreateEventTracker</c> using the same dataset group as an existing event tracker. </para></note><para> When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. </para><para> The event tracker can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> To get the status of the event tracker, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>. </para><note><para> The event tracker must be in the ACTIVE state before using the tracking ID. </para></note><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html">ListEventTrackers</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html">DeleteEventTracker</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Name"> <summary> <para> <para>The name for the event tracker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the event tracker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateEventTrackerResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateEventTrackerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet"> <summary> Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of the dataset group that the filter will belong to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.FilterExpression"> <summary> <para> <para>The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html">Filter expressions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.Name"> <summary> <para> <para>The name of the filter to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FilterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateFilterResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet"> <summary> Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.S3DataDestination_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.Metric"> <summary> <para> <para>A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are <c>SUM()</c> or <c>SAMPLECOUNT()</c>. For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.Name"> <summary> <para> <para>A name for the metric attribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.S3DataDestination_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.MetricsOutputConfig_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricAttributionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateMetricAttributionResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateMetricAttributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSMetricAttributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet"> <summary> Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> request. <para><b>Minimum recommendation requests per second</b></para><important><para> A high <c>minRecommendationRequestsPerSecond</c> will increase your bill. We recommend starting with 1 for <c>minRecommendationRequestsPerSecond</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minRecommendationRequestsPerSecond</c> as necessary. </para></important><para> When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (<c>minRecommendationRequestsPerSecond</c>) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is <c>1</c>. A recommendation request is a single <c>GetRecommendations</c> operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage. </para><para> If your requests per second increases beyond <c>minRecommendationRequestsPerSecond</c>, Amazon Personalize auto-scales the provisioned capacity up and down, but never below <c>minRecommendationRequestsPerSecond</c>. There's a short time delay while the capacity is increased that might cause loss of requests. </para><para> Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default <c>minRecommendationRequestsPerSecond</c>, track your usage using Amazon CloudWatch metrics, and then increase the <c>minRecommendationRequestsPerSecond</c> as necessary. </para><para><b>Status</b></para><para> A recommender can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> To get the recommender status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>. </para><note><para> Wait until the <c>status</c> of the recommender is <c>ACTIVE</c> before asking the recommender for recommendations. </para></note><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html">ListRecommenders</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html">UpdateRecommender</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html">DeleteRecommender</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.RecommenderConfig_EnableMetadataWithRecommendation"> <summary> <para> <para>Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata">Enabling metadata in recommendations for a recommender</a>.</para><para> If you enable metadata in recommendations, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.TrainingDataConfig_ExcludedDatasetColumn"> <summary> <para> <para>Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.</para><para> For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.RecommenderConfig_ItemExplorationConfig"> <summary> <para> <para>Specifies the exploration configuration hyperparameters, including <c>explorationWeight</c> and <c>explorationItemAgeCutOff</c>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide <c>itemExplorationConfig</c> data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.RecommenderConfig_MinRecommendationRequestsPerSecond"> <summary> <para> <para>Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high <c>minRecommendationRequestsPerSecond</c> will increase your bill. We recommend starting with 1 for <c>minRecommendationRequestsPerSecond</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minRecommendationRequestsPerSecond</c> as necessary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.Name"> <summary> <para> <para>The name of the recommender.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.RecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateRecommenderResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateRecommenderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSRecommenderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet"> <summary> Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. <para> Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>. </para><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html">ListSchemas</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html">DescribeSchema</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html">DeleteSchema</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Domain"> <summary> <para> <para>The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Name"> <summary> <para> <para>The name for the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Schema"> <summary> <para> <para>A schema in Avro JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateSchemaResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet"> <summary> <important><para> By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html">update the solution</a> to turn off automatic training. For information about training costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para></important><para> Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>. </para><para> By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html">Configuring automatic training</a>. </para><para> To turn off automatic training, set <c>performAutoTraining</c> to false. If you turn off automatic training, you must manually create a solution version by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. </para><para> After training starts, you can get the solution version's Amazon Resource Name (ARN) with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a> API operation. To get its status, use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. </para><para> After training completes you can evaluate model accuracy by calling <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the solution version, you deploy it using <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. The campaign provides recommendations to a client through the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API. </para><note><para> Amazon Personalize doesn't support configuring the <c>hpoObjective</c> for solution hyperparameter optimization at this time. </para></note><para><b>Status</b></para><para> A solution can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> To get the status of the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>. If you use manual training, the status must be ACTIVE before you call <c>CreateSolutionVersion</c>. </para><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html">UpdateSolution</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a></para></li></ul><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_AlgorithmHyperParameter"> <summary> <para> <para>Lists the algorithm hyperparameters and their values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_CategoricalHyperParameterRange"> <summary> <para> <para>The categorical hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_ContinuousHyperParameterRange"> <summary> <para> <para>The continuous hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.EventType"> <summary> <para> <para>When your have multiple event types (using an <c>EVENT_TYPE</c> schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.</para><para>If you do not provide an <c>eventType</c>, Amazon Personalize will use all interactions for training with equal weight regardless of type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_EventValueThreshold"> <summary> <para> <para>Only events with a value greater than or equal to this threshold are used for training a model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.TrainingDataConfig_ExcludedDatasetColumn"> <summary> <para> <para>Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.</para><para> For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_FeatureTransformationParameter"> <summary> <para> <para>Lists the feature transformation parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_IntegerHyperParameterRange"> <summary> <para> <para>The integer-valued hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.OptimizationObjective_ItemAttribute"> <summary> <para> <para>The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoResourceConfig_MaxNumberOfTrainingJob"> <summary> <para> <para>The maximum number of training jobs when you create a solution version. The maximum value for <c>maxNumberOfTrainingJobs</c> is <c>40</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoResourceConfig_MaxParallelTrainingJob"> <summary> <para> <para>The maximum number of parallel training jobs when you create a solution version. The maximum value for <c>maxParallelTrainingJobs</c> is <c>10</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AutoMLConfig_MetricName"> <summary> <para> <para>The metric to optimize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_MetricName"> <summary> <para> <para>The name of the metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_MetricRegex"> <summary> <para> <para>A regular expression for finding the metric in the training job logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Name"> <summary> <para> <para>The name for the solution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.OptimizationObjective_ObjectiveSensitivity"> <summary> <para> <para>Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.PerformAutoML"> <summary> <para> <important><para>We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html">Choosing a recipe</a>.</para></important><para>Whether to perform automated machine learning (AutoML). The default is <c>false</c>. For this case, you must specify <c>recipeArn</c>.</para><para>When set to <c>true</c>, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit <c>recipeArn</c>. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.PerformAutoTraining"> <summary> <para> <para>Whether the solution uses automatic training to create new solution versions (trained models). The default is <c>True</c> and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a <c>schedulingExpression</c> in the <c>AutoTrainingConfig</c> as part of solution configuration. For more information about automatic training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html">Configuring automatic training</a>.</para><para> Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. </para><para> After training starts, you can get the solution version's Amazon Resource Name (ARN) with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a> API operation. To get its status, use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.PerformHPO"> <summary> <para> <para>Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is <c>false</c>.</para><para>When performing AutoML, this parameter is always <c>true</c> and you should not set it to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.RecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when <c>performAutoML</c> is false. For information about different Amazon Personalize recipes and their ARNs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html">Choosing a recipe</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AutoMLConfig_RecipeList"> <summary> <para> <para>The list of candidate recipes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AutoTrainingConfig_SchedulingExpression"> <summary> <para> <para>Specifies how often to automatically train new solution versions. Specify a rate expression in rate(<i>value</i><i>unit</i>) format. For value, specify a number between 1 and 30. For unit, specify <c>day</c> or <c>days</c>. For example, to automatically create a new solution version every 5 days, specify <c>rate(5 days)</c>. The default is every 7 days.</para><para>For more information about auto training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the solution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_Type"> <summary> <para> <para>The type of the metric. Valid values are <c>Maximize</c> and <c>Minimize</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SolutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateSolutionResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateSolutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet"> <summary> Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> operation and must be in the ACTIVE state before calling <c>CreateSolutionVersion</c>. A new version of the solution is created every time you call this operation. <para><b>Status</b></para><para> A solution version can be in one of the following states: </para><ul><li><para> CREATE PENDING </para></li><li><para> CREATE IN_PROGRESS </para></li><li><para> ACTIVE </para></li><li><para> CREATE FAILED </para></li><li><para> CREATE STOPPING </para></li><li><para> CREATE STOPPED </para></li></ul><para> To get the status of the version, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. Wait until the status shows as ACTIVE before calling <c>CreateCampaign</c>. </para><para> If the status shows as CREATE FAILED, the response includes a <c>failureReason</c> key, which describes why the job failed. </para><para><b>Related APIs</b></para><ul><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a></para></li><li><para><a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.Name"> <summary> <para> <para>The name of the solution version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution containing the training configuration information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.Tag"> <summary> <para> <para>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the solution version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.TrainingMode"> <summary> <para> <para>The scope of training to be performed when creating the solution version. The default is <c>FULL</c>. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group. </para><para>If you use <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a>, you can specify a training mode of <c>UPDATE</c>. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify <c>UPDATE</c>, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to <c>FULL</c> and deploy it in a campaign. For more information about automatic updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates">Automatic updates</a>. </para><para>The <c>UPDATE</c> option can only be used when you already have an active solution version created from the input solution using the <c>FULL</c> option and the input solution was trained with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a> recipe or the legacy <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html">HRNN-Coldstart</a> recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SolutionVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateSolutionVersionResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateSolutionVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> request. For information on creating campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteCampaignResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet"> <summary> Deletes a dataset. You can't delete a dataset if an associated <c>DatasetImportJob</c> or <c>SolutionVersion</c> is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet"> <summary> Deletes a dataset group. Before you delete a dataset group, you must delete the following: <ul><li><para> All associated event trackers. </para></li><li><para> All associated solutions. </para></li><li><para> All datasets in the dataset group. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of the dataset group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteDatasetGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet"> <summary> Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.EventTrackerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the event tracker to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteEventTrackerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSFilterCmdlet"> <summary> Deletes a filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSFilterCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSMetricAttributionCmdlet"> <summary> Deletes a metric attribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSMetricAttributionCmdlet.MetricAttributionArn"> <summary> <para> <para>The metric attribution's Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSMetricAttributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteMetricAttributionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSMetricAttributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSRecommenderCmdlet"> <summary> Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSRecommenderCmdlet.RecommenderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteRecommenderResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSRecommenderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSResourceTagCmdlet"> <summary> Removes the specified tags that are attached to a resource. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html">Removing tags from Amazon Personalize resources</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource's Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet"> <summary> Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schema to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteSchemaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet"> <summary> Deletes all versions of a solution and the <c>Solution</c> object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated <c>SolutionVersion</c> is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.SolutionArn"> <summary> <para> <para>The ARN of the solution to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.DeleteSolutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.StartPERSRecommenderCmdlet"> <summary> Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StartPERSRecommenderCmdlet.RecommenderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StartPERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.StartRecommenderResponse). Specifying the name of a property of type Amazon.Personalize.Model.StartRecommenderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StartPERSRecommenderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.StopPERSRecommenderCmdlet"> <summary> Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSRecommenderCmdlet.RecommenderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.StopRecommenderResponse). Specifying the name of a property of type Amazon.Personalize.Model.StopRecommenderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSRecommenderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.StopPERSSolutionVersionCreationCmdlet"> <summary> Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. <para> Depending on the current state of the solution version, the solution version state changes as follows: </para><ul><li><para> CREATE_PENDING > CREATE_STOPPED </para><para> or </para></li><li><para> CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED </para></li></ul><para> You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSSolutionVersionCreationCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version you want to stop creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSSolutionVersionCreationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.StopSolutionVersionCreationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.StopPERSSolutionVersionCreationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet"> <summary> Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's <c>minProvisionedTPS</c>, or modify your campaign's configuration. For example, you can set <c>enableMetadataWithRecommendations</c> to true for an existing campaign. <para> To update a campaign to start automatically using the latest solution version, specify the following: </para><ul><li><para> For the <c>SolutionVersionArn</c> parameter, specify the Amazon Resource Name (ARN) of your solution in <c>SolutionArn/$LATEST</c> format. </para></li><li><para> In the <c>campaignConfig</c>, set <c>syncWithLatestSolutionVersion</c> to <c>true</c>. </para></li></ul><para> To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> operation. </para><note><para> You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is <c>Active</c>. </para></note><para> For more information about updating a campaign, including code samples, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html">Updating a campaign</a>. For more information about campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html">Creating a campaign</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.CampaignConfig_EnableMetadataWithRecommendation"> <summary> <para> <para>Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata">Enabling metadata in recommendations for a campaign</a>.</para><para> If you enable metadata in recommendations, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.CampaignConfig_ItemExplorationConfig"> <summary> <para> <para>Specifies the exploration configuration hyperparameters, including <c>explorationWeight</c> and <c>explorationItemAgeCutOff</c>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide <c>itemExplorationConfig</c> data only if your solution uses the <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a> recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.MinProvisionedTPS"> <summary> <para> <para>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high <c>minProvisionedTPS</c> will increase your bill. We recommend starting with 1 for <c>minProvisionedTPS</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minProvisionedTPS</c> as necessary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your <i>solution</i> in <c>SolutionArn/$LATEST</c> format. You must use this format if you set <c>syncWithLatestSolutionVersion</c> to <c>True</c> in the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html">CampaignConfig</a>. </para><para> To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. </para><para> For more information about automatic campaign updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.CampaignConfig_SyncWithLatestSolutionVersion"> <summary> <para> <para>Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify <c>True</c>, you must specify the ARN of your <i>solution</i> for the <c>SolutionVersionArn</c> parameter. It must be in <c>SolutionArn/$LATEST</c> format. The default is <c>False</c> and you must manually update the campaign to deploy the latest solution version. </para><para> For more information about automatic campaign updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UpdateCampaignResponse). Specifying the name of a property of type Amazon.Personalize.Model.UpdateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSDatasetCmdlet"> <summary> Update a dataset to replace its schema with a new or existing one. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html">Replacing a dataset's schema</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSDatasetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the new schema you want use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UpdateDatasetResponse). Specifying the name of a property of type Amazon.Personalize.Model.UpdateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet"> <summary> Updates a metric attribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.AddMetric"> <summary> <para> <para>Add new metric attributes to the metric attribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.S3DataDestination_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.MetricAttributionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the metric attribution to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.S3DataDestination_Path"> <summary> <para> <para>The file path of the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.RemoveMetric"> <summary> <para> <para>Remove metric attributes from the metric attribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.MetricsOutputConfig_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricAttributionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UpdateMetricAttributionResponse). Specifying the name of a property of type Amazon.Personalize.Model.UpdateMetricAttributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSMetricAttributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet"> <summary> Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the <c>latestRecommenderUpdate</c> returned in the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.RecommenderConfig_EnableMetadataWithRecommendation"> <summary> <para> <para>Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata">Enabling metadata in recommendations for a recommender</a>.</para><para> If you enable metadata in recommendations, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.TrainingDataConfig_ExcludedDatasetColumn"> <summary> <para> <para>Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.</para><para> For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.RecommenderConfig_ItemExplorationConfig"> <summary> <para> <para>Specifies the exploration configuration hyperparameters, including <c>explorationWeight</c> and <c>explorationItemAgeCutOff</c>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide <c>itemExplorationConfig</c> data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.RecommenderConfig_MinRecommendationRequestsPerSecond"> <summary> <para> <para>Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high <c>minRecommendationRequestsPerSecond</c> will increase your bill. We recommend starting with 1 for <c>minRecommendationRequestsPerSecond</c> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <c>minRecommendationRequestsPerSecond</c> as necessary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.RecommenderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommender to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommenderArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UpdateRecommenderResponse). Specifying the name of a property of type Amazon.Personalize.Model.UpdateRecommenderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSRecommenderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet"> <summary> Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/updating-solution.html">Updating a solution</a>. <para> A solution update can be in one of the following states: </para><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para><para> To get the status of a solution update, call the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a> API operation and find the status in the <c>latestSolutionUpdate</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet.PerformAutoTraining"> <summary> <para> <para>Whether the solution uses automatic training to create new solution versions (trained models). You can change the training frequency by specifying a <c>schedulingExpression</c> in the <c>AutoTrainingConfig</c> as part of solution configuration. </para><para> If you turn on automatic training, the first automatic training starts within one hour after the solution update completes. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information about automatic training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html">Configuring automatic training</a>. </para><para> After training starts, you can get the solution version's Amazon Resource Name (ARN) with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a> API operation. To get its status, use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet.AutoTrainingConfig_SchedulingExpression"> <summary> <para> <para>Specifies how often to automatically train new solution versions. Specify a rate expression in rate(<i>value</i><i>unit</i>) format. For value, specify a number between 1 and 30. For unit, specify <c>day</c> or <c>days</c>. For example, to automatically create a new solution version every 5 days, specify <c>rate(5 days)</c>. The default is every 7 days.</para><para>For more information about auto training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SolutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.UpdateSolutionResponse). Specifying the name of a property of type Amazon.Personalize.Model.UpdateSolutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSSolutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |