# BatchSegmentJob
<a name="API_BatchSegmentJob"></a>

Contains information on a batch segment job.

## Contents
<a name="API_BatchSegmentJob_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJob-batchSegmentJobArn"></a>
The Amazon Resource Name (ARN) of the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJob-creationDateTime"></a>
The time at which the batch segment job was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-BatchSegmentJob-failureReason"></a>
If the batch segment job failed, the reason for the failure.  
Type: String  
Required: No

 ** filterArn **   <a name="personalize-Type-BatchSegmentJob-filterArn"></a>
The ARN of the filter used on the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** jobInput **   <a name="personalize-Type-BatchSegmentJob-jobInput"></a>
The Amazon S3 path that leads to the input data used to generate the batch segment job.  
Type: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) object  
Required: No

 ** jobName **   <a name="personalize-Type-BatchSegmentJob-jobName"></a>
The name of the batch segment job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** jobOutput **   <a name="personalize-Type-BatchSegmentJob-jobOutput"></a>
The Amazon S3 bucket that contains the output data generated by the batch segment job.  
Type: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) object  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJob-lastUpdatedDateTime"></a>
The time at which the batch segment job last updated.  
Type: Timestamp  
Required: No

 ** numResults **   <a name="personalize-Type-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.  
Type: Integer  
Required: No

 ** roleArn **   <a name="personalize-Type-BatchSegmentJob-roleArn"></a>
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJob-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-BatchSegmentJob-status"></a>
The status of the batch segment job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_BatchSegmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob)