This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Personalize::BatchInferenceJob
<a name="aws-resource-personalize-batchinferencejob"></a>

Contains information on a batch inference job.

## Syntax
<a name="aws-resource-personalize-batchinferencejob-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-personalize-batchinferencejob-syntax.json"></a>

```
{
  "Type" : "AWS::Personalize::BatchInferenceJob",
  "Properties" : {
      "[BatchInferenceJobMode](#cfn-personalize-batchinferencejob-batchinferencejobmode)" : {{String}},
      "[JobInput](#cfn-personalize-batchinferencejob-jobinput)" : {{BatchInferenceJobInput}},
      "[JobName](#cfn-personalize-batchinferencejob-jobname)" : {{String}},
      "[JobOutput](#cfn-personalize-batchinferencejob-joboutput)" : {{BatchInferenceJobOutput}},
      "[NumResults](#cfn-personalize-batchinferencejob-numresults)" : {{Integer}},
      "[RoleArn](#cfn-personalize-batchinferencejob-rolearn)" : {{String}},
      "[SolutionVersionArn](#cfn-personalize-batchinferencejob-solutionversionarn)" : {{String}},
      "[Tags](#cfn-personalize-batchinferencejob-tags)" : {{[ Tag, ... ]}}
    }
}
```

### YAML
<a name="aws-resource-personalize-batchinferencejob-syntax.yaml"></a>

```
Type: AWS::Personalize::BatchInferenceJob
Properties:
  [BatchInferenceJobMode](#cfn-personalize-batchinferencejob-batchinferencejobmode): {{String}}
  [JobInput](#cfn-personalize-batchinferencejob-jobinput): {{
    BatchInferenceJobInput}}
  [JobName](#cfn-personalize-batchinferencejob-jobname): {{String}}
  [JobOutput](#cfn-personalize-batchinferencejob-joboutput): {{
    BatchInferenceJobOutput}}
  [NumResults](#cfn-personalize-batchinferencejob-numresults): {{Integer}}
  [RoleArn](#cfn-personalize-batchinferencejob-rolearn): {{String}}
  [SolutionVersionArn](#cfn-personalize-batchinferencejob-solutionversionarn): {{String}}
  [Tags](#cfn-personalize-batchinferencejob-tags): {{
    - Tag}}
```

## Properties
<a name="aws-resource-personalize-batchinferencejob-properties"></a>

`BatchInferenceJobMode`  <a name="cfn-personalize-batchinferencejob-batchinferencejobmode"></a>
The job's mode.  
*Required*: No  
*Type*: String  
*Allowed values*: `BATCH_INFERENCE | THEME_GENERATION`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`JobInput`  <a name="cfn-personalize-batchinferencejob-jobinput"></a>
The Amazon S3 path that leads to the input data used to generate the batch inference job.  
*Required*: No  
*Type*: [BatchInferenceJobInput](aws-properties-personalize-batchinferencejob-batchinferencejobinput.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`JobName`  <a name="cfn-personalize-batchinferencejob-jobname"></a>
The name of the batch inference job.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`JobOutput`  <a name="cfn-personalize-batchinferencejob-joboutput"></a>
The Amazon S3 bucket that contains the output data generated by the batch inference job.  
*Required*: No  
*Type*: [BatchInferenceJobOutput](aws-properties-personalize-batchinferencejob-batchinferencejoboutput.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NumResults`  <a name="cfn-personalize-batchinferencejob-numresults"></a>
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleArn`  <a name="cfn-personalize-batchinferencejob-rolearn"></a>
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SolutionVersionArn`  <a name="cfn-personalize-batchinferencejob-solutionversionarn"></a>
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:([a-z\d-]+):personalize:.*:.*:.+$`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-personalize-batchinferencejob-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-personalize-batchinferencejob-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-personalize-batchinferencejob-return-values"></a>

### Ref
<a name="aws-resource-personalize-batchinferencejob-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-personalize-batchinferencejob-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-personalize-batchinferencejob-return-values-fn--getatt-fn--getatt"></a>

`BatchInferenceJobArn`  <a name="BatchInferenceJobArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the batch inference job.

`CreationDateTime`  <a name="CreationDateTime-fn::getatt"></a>
The time at which the batch inference job was created.

`LastUpdatedDateTime`  <a name="LastUpdatedDateTime-fn::getatt"></a>
The time at which the batch inference job was last updated.

`Status`  <a name="Status-fn::getatt"></a>
The status of the batch inference job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED