Class: Aws::Personalize::Types::CreateBatchSegmentJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::CreateBatchSegmentJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter_arn ⇒ String

  The ARN of the filter to apply to the batch segment job.

• #job_input ⇒ Types::BatchSegmentJobInput

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

• #job_name ⇒ String

  The name of the batch segment job to create.

• #job_output ⇒ Types::BatchSegmentJobOutput

  The Amazon S3 path for the bucket where the job’s output will be stored.

• #num_results ⇒ Integer

  The number of predicted users generated by the batch segment job for each line of input data.

• #role_arn ⇒ String

  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.

• #solution_version_arn ⇒ String

  The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

• #tags ⇒ Array<Types::Tag>

  A list of [tags] to apply to the batch segment job.

Instance Attribute Details

#filter_arn ⇒ String

The ARN of the filter to apply to the batch segment job. For more information on using filters, see [Filtering batch recommendations].

[1]: docs.aws.amazon.com/personalize/latest/dg/filter-batch.html

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_input ⇒ Types::BatchSegmentJobInput

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

Returns:

• (Types::BatchSegmentJobInput)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the batch segment job to create.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_output ⇒ Types::BatchSegmentJobOutput

The Amazon S3 path for the bucket where the job’s output will be stored.

Returns:

• (Types::BatchSegmentJobOutput)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#num_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arn ⇒ String

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of [tags] to apply to the batch segment job.

[1]: docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-personalize/types.rb', line 1003

class CreateBatchSegmentJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end