Class: Aws::IoTSiteWise::Types::CreateBulkImportJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::CreateBulkImportJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #adaptive_ingestion ⇒ Boolean

  If set to true, ingest new data into IoT SiteWise storage.

• #dataset_id ⇒ String

  The ID of the session dataset to ingest data into.

• #delete_files_after_import ⇒ Boolean

  If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

• #error_report_location ⇒ Types::ErrorReportLocation

  The Amazon S3 destination where errors associated with the job creation request are saved.

• #files ⇒ Array<Types::File>

  The files in the specified Amazon S3 bucket that contain your data.

• #job_configuration ⇒ Types::JobConfiguration

  Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

• #job_name ⇒ String

  The unique name that helps identify the job request.

• #job_role_arn ⇒ String

  The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon S3 data.

• #workspace_name ⇒ String

  The name of the workspace that contains the session dataset.

Instance Attribute Details

#adaptive_ingestion ⇒ Boolean

If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The ID of the session dataset to ingest data into. Specify this field, together with workspaceName, to ingest data into a session dataset in a workspace.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#delete_files_after_import ⇒ Boolean

If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#error_report_location ⇒ Types::ErrorReportLocation

The Amazon S3 destination where errors associated with the job creation request are saved.

Returns:

• (Types::ErrorReportLocation)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#files ⇒ Array<Types::File>

The files in the specified Amazon S3 bucket that contain your data. You can specify up to 100 files for each bulk import job. Each file supports the following size limits:

• Parquet files – Up to 256 MiB.

• Other file formats – Up to 5 GiB.

Returns:

• (Array<Types::File>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#job_configuration ⇒ Types::JobConfiguration

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

Returns:

• (Types::JobConfiguration)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The unique name that helps identify the job request.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#job_role_arn ⇒ String

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace that contains the session dataset. Specify this field together with datasetId.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 3959

class CreateBulkImportJobRequest < Struct.new(
  :job_name,
  :job_role_arn,
  :files,
  :error_report_location,
  :job_configuration,
  :adaptive_ingestion,
  :delete_files_after_import,
  :dataset_id,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end