Class: Aws::Personalize::Types::CreateDatasetExportJobRequest

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 CreateDatasetExportJobRequest data as a hash:

{
  job_name: "Name", # required
  dataset_arn: "Arn", # required
  ingestion_mode: "BULK", # accepts BULK, PUT, ALL
  role_arn: "RoleArn", # required
  job_output: { # required
    s3_data_destination: { # required
      path: "S3Location", # required
      kms_key_arn: "KmsKeyArn",
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_arnString

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

Returns:

  • (String)


830
831
832
833
834
835
836
837
838
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 830

class CreateDatasetExportJobRequest < Struct.new(
  :job_name,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :job_output)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_modeString

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

Returns:

  • (String)


830
831
832
833
834
835
836
837
838
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 830

class CreateDatasetExportJobRequest < Struct.new(
  :job_name,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :job_output)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name for the dataset export job.

Returns:

  • (String)


830
831
832
833
834
835
836
837
838
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 830

class CreateDatasetExportJobRequest < Struct.new(
  :job_name,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :job_output)
  SENSITIVE = []
  include Aws::Structure
end

#job_outputTypes::DatasetExportJobOutput

The path to the Amazon S3 bucket where the job's output is stored.



830
831
832
833
834
835
836
837
838
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 830

class CreateDatasetExportJobRequest < Struct.new(
  :job_name,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :job_output)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

Returns:

  • (String)


830
831
832
833
834
835
836
837
838
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 830

class CreateDatasetExportJobRequest < Struct.new(
  :job_name,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :job_output)
  SENSITIVE = []
  include Aws::Structure
end