AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Personalize CreateBatchInferenceJob API operation.

Syntax

New-PERSBatchInferenceJob
-JobName <String>
-BatchInferenceJobMode <BatchInferenceJobMode>
-FilterArn <String>
-BatchInferenceJobConfig_ItemExplorationConfig <Hashtable>
-FieldsForThemeGeneration_ItemName <String>
-S3DataSource_KmsKeyArn <String>
-S3DataDestination_KmsKeyArn <String>
-NumResult <Int32>
-S3DataSource_Path <String>
-S3DataDestination_Path <String>
-BatchInferenceJobConfig_RankingInfluence <Hashtable>
-RoleArn <String>
-SolutionVersionArn <String>
-Tag <Tag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPersonalizeConfig>

Description

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. 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. For more information, see Creating a batch inference job . 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 THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

Parameters

-BatchInferenceJobConfig_ItemExplorationConfig <Hashtable>
A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BatchInferenceJobConfig_RankingInfluence <Hashtable>
A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BatchInferenceJobMode <BatchInferenceJobMode>
The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE. When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonPersonalizeConfig>
Amazon.PowerShell.Cmdlets.PERS.AmazonPersonalizeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FieldsForThemeGeneration_ItemName <String>
The name of the Items dataset column that stores the name of each item in the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesThemeGenerationConfig_FieldsForThemeGeneration_ItemName
-FilterArn <String>
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
The name of the batch inference job to create.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NumResult <Int32>
The number of recommendations to retrieve.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumResults
-RoleArn <String>
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DataDestination_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobOutput_S3DataDestination_KmsKeyArn
-S3DataDestination_Path <String>
The file path of the Amazon S3 bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobOutput_S3DataDestination_Path
-S3DataSource_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobInput_S3DataSource_KmsKeyArn
-S3DataSource_Path <String>
The file path of the Amazon S3 bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobInput_S3DataSource_Path
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SolutionVersionArn <String>
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of tags to apply to the batch inference job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Personalize.Model.CreateBatchInferenceJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Personalize.Model.CreateBatchInferenceJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z