View a markdown version of this page

AWS::Personalize::BatchInferenceJob - 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::BatchInferenceJob

Contains information on a batch inference job.

Syntax

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

JSON

{
  "Type" : "AWS::Personalize::BatchInferenceJob",
  "Properties" : {
      "BatchInferenceJobMode" : String,
      "JobInput" : BatchInferenceJobInput,
      "JobName" : String,
      "JobOutput" : BatchInferenceJobOutput,
      "NumResults" : Integer,
      "RoleArn" : String,
      "SolutionVersionArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::BatchInferenceJob
Properties:
  BatchInferenceJobMode: String
  JobInput: 
    BatchInferenceJobInput
  JobName: String
  JobOutput: 
    BatchInferenceJobOutput
  NumResults: Integer
  RoleArn: String
  SolutionVersionArn: String
  Tags: 
    - Tag

Properties

BatchInferenceJobMode

The job's mode.

Required: No

Type: String

Allowed values: BATCH_INFERENCE | THEME_GENERATION

Update requires: Replacement

JobInput

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

Required: No

Type: BatchInferenceJobInput

Update requires: Replacement

JobName

The name of the batch inference 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 inference job.

Required: No

Type: BatchInferenceJobOutput

Update requires: Replacement

NumResults

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Required: No

Type: Integer

Update requires: Replacement

RoleArn

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference 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 from which the batch inference job was created.

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

BatchInferenceJobArn

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

CreationDateTime

The time at which the batch inference job was created.

LastUpdatedDateTime

The time at which the batch inference job was last updated.

Status

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

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED