View a markdown version of this page

AWS::Personalize::BatchSegmentJob - AWS CloudFormation
SyntaxPropertiesReturn values

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.

AWS::Personalize::BatchSegmentJob

Contains information on a batch segment job.

Syntax

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

JSON

{
  "Type" : "AWS::Personalize::BatchSegmentJob",
  "Properties" : {
      "JobInput" : BatchSegmentJobInput,
      "JobName" : String,
      "JobOutput" : BatchSegmentJobOutput,
      "NumResults" : Integer,
      "RoleArn" : String,
      "SolutionVersionArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::BatchSegmentJob
Properties:
  JobInput: 
    BatchSegmentJobInput
  JobName: String
  JobOutput: 
    BatchSegmentJobOutput
  NumResults: Integer
  RoleArn: String
  SolutionVersionArn: String
  Tags: 
    - Tag

Properties

JobInput

The Amazon S3 path that leads to the input data used to generate the batch segment job.

Required: No

Type: BatchSegmentJobInput

Update requires: Replacement

JobName

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

JobOutput

The Amazon S3 bucket that contains the output data generated by the batch segment job.

Required: No

Type: BatchSegmentJobOutput

Update requires: Replacement

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.

Required: No

Type: Integer

Update requires: Replacement

RoleArn

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

SolutionVersionArn

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

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

BatchSegmentJobArn

The Amazon Resource Name (ARN) of the batch segment job.

CreationDateTime

The time at which the batch segment job was created.

LastUpdatedDateTime

The time at which the batch segment job last updated.

Status

The status of the batch segment job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED