CreateBatchSegmentJob
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
Request Syntax
{
"filterArn": "string",
"jobInput": {
"s3DataSource": {
"kmsKeyArn": "string",
"path": "string"
}
},
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"numResults": number,
"roleArn": "string",
"solutionVersionArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}Request Parameters
The request accepts the following data in JSON format.
- filterArn
-
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+Required: No
- jobInput
-
The Amazon S3 path for the input data used to generate the batch segment job.
Type: BatchSegmentJobInput object
Required: Yes
- jobName
-
The name of the batch segment job to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9\-_]*Required: Yes
- jobOutput
-
The Amazon S3 path for the bucket where the job's output will be stored.
Type: BatchSegmentJobOutput object
Required: Yes
- 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 role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+Required: Yes
- solutionVersionArn
-
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+Required: Yes
-
A list of tags to apply to the batch segment job.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"batchSegmentJobArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- batchSegmentJobArn
-
The ARN of the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Errors
- InvalidInputException
-
Provide a valid value for the field or parameter.
HTTP Status Code: 400
- LimitExceededException
-
The limit on the number of requests per second has been exceeded.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified resource already exists.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in use.
HTTP Status Code: 400
- ResourceNotFoundException
-
Could not find the specified resource.
HTTP Status Code: 400
- TooManyTagsException
-
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
