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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-personalize/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_arnString

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)


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_inputTypes::BatchSegmentJobInput

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



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_nameString

The name of the batch segment job to create.

Returns:

  • (String)


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_outputTypes::BatchSegmentJobOutput

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



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_resultsInteger

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)


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_arnString

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)


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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_arnString

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

Returns:

  • (String)


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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

#tagsArray<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:



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# 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