AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::LookoutMetrics::Types::S3SourceConfig

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

Overview

Note:

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

{
  role_arn: "Arn", # required
  templated_path_list: ["TemplatedPath"],
  historical_data_path_list: ["HistoricalDataPath"],
  file_format_descriptor: {
    csv_format_descriptor: {
      file_compression: "NONE", # accepts NONE, GZIP
      charset: "Charset",
      contains_header: false,
      delimiter: "Delimiter",
      header_list: ["ColumnName"],
      quote_symbol: "QuoteSymbol",
    },
    json_format_descriptor: {
      file_compression: "NONE", # accepts NONE, GZIP
      charset: "Charset",
    },
  },
}

Contains information about the configuration of the S3 bucket that contains source files.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#file_format_descriptorTypes::FileFormatDescriptor

Contains information about a source file's formatting.



2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 2317

class S3SourceConfig < Struct.new(
  :role_arn,
  :templated_path_list,
  :historical_data_path_list,
  :file_format_descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#historical_data_path_listArray<String>

A list of paths to the historical data files.

Returns:

  • (Array<String>)


2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 2317

class S3SourceConfig < Struct.new(
  :role_arn,
  :templated_path_list,
  :historical_data_path_list,
  :file_format_descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

Returns:

  • (String)


2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 2317

class S3SourceConfig < Struct.new(
  :role_arn,
  :templated_path_list,
  :historical_data_path_list,
  :file_format_descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#templated_path_listArray<String>

A list of templated paths to the source files.

Returns:

  • (Array<String>)


2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 2317

class S3SourceConfig < Struct.new(
  :role_arn,
  :templated_path_list,
  :historical_data_path_list,
  :file_format_descriptor)
  SENSITIVE = []
  include Aws::Structure
end