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

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

Overview

Note:

When making an API call, you may pass CreateBatchSegmentJobRequest data as a hash:

{
  job_name: "Name", # required
  solution_version_arn: "Arn", # required
  filter_arn: "Arn",
  num_results: 1,
  job_input: { # required
    s3_data_source: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
  job_output: { # required
    s3_data_destination: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
  role_arn: "RoleArn", # required
  tags: [
    {
      tag_key: "TagKey", # required
      tag_value: "TagValue", # required
    },
  ],
}

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.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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.

Returns:

  • (Integer)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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.

Returns:



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1045

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