BatchSegmentJob
Contains information on a batch segment job.
Contents
- batchSegmentJobArn
-
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
-
The time at which the batch segment job was created.
Type: Timestamp
Required: No
- failureReason
-
If the batch segment job failed, the reason for the failure.
Type: String
Required: No
- filterArn
-
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
-
The Amazon S3 path that leads to the input data used to generate the batch segment job.
Type: BatchSegmentJobInput object
Required: No
- jobName
-
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
-
The Amazon S3 bucket that contains the output data generated by the batch segment job.
Type: BatchSegmentJobOutput object
Required: No
- lastUpdatedDateTime
-
The time at which the batch segment job last updated.
Type: Timestamp
Required: No
- numResults
-
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
-
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
-
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
-
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
For more information about using this API in one of the language-specific Amazon SDKs, see the following: