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::BatchSegmentJob
<a name="aws-resource-personalize-batchsegmentjob"></a>

Contains information on a batch segment job.

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

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

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

```
{
  "Type" : "AWS::Personalize::BatchSegmentJob",
  "Properties" : {
      "[JobInput](#cfn-personalize-batchsegmentjob-jobinput)" : {{BatchSegmentJobInput}},
      "[JobName](#cfn-personalize-batchsegmentjob-jobname)" : {{String}},
      "[JobOutput](#cfn-personalize-batchsegmentjob-joboutput)" : {{BatchSegmentJobOutput}},
      "[NumResults](#cfn-personalize-batchsegmentjob-numresults)" : {{Integer}},
      "[RoleArn](#cfn-personalize-batchsegmentjob-rolearn)" : {{String}},
      "[SolutionVersionArn](#cfn-personalize-batchsegmentjob-solutionversionarn)" : {{String}},
      "[Tags](#cfn-personalize-batchsegmentjob-tags)" : {{[ Tag, ... ]}}
    }
}
```

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

```
Type: AWS::Personalize::BatchSegmentJob
Properties:
  [JobInput](#cfn-personalize-batchsegmentjob-jobinput): {{
    BatchSegmentJobInput}}
  [JobName](#cfn-personalize-batchsegmentjob-jobname): {{String}}
  [JobOutput](#cfn-personalize-batchsegmentjob-joboutput): {{
    BatchSegmentJobOutput}}
  [NumResults](#cfn-personalize-batchsegmentjob-numresults): {{Integer}}
  [RoleArn](#cfn-personalize-batchsegmentjob-rolearn): {{String}}
  [SolutionVersionArn](#cfn-personalize-batchsegmentjob-solutionversionarn): {{String}}
  [Tags](#cfn-personalize-batchsegmentjob-tags): {{
    - Tag}}
```

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

`JobInput`  <a name="cfn-personalize-batchsegmentjob-jobinput"></a>
The Amazon S3 path that leads to the input data used to generate the batch segment job.  
*Required*: No  
*Type*: [BatchSegmentJobInput](aws-properties-personalize-batchsegmentjob-batchsegmentjobinput.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-batchsegmentjob-jobname"></a>
The name of the batch segment 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-batchsegmentjob-joboutput"></a>
The Amazon S3 bucket that contains the output data generated by the batch segment job.  
*Required*: No  
*Type*: [BatchSegmentJobOutput](aws-properties-personalize-batchsegmentjob-batchsegmentjoboutput.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-batchsegmentjob-numresults"></a>
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.  
*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-batchsegmentjob-rolearn"></a>
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment 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-batchsegmentjob-solutionversionarn"></a>
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.  
*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-batchsegmentjob-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-personalize-batchsegmentjob-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-batchsegmentjob-return-values"></a>

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

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

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

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

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

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

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