Class: Aws::S3::Types::CSVOutput

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

Overview

Note:

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

{
  quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
  quote_escape_character: "QuoteEscapeCharacter",
  record_delimiter: "RecordDelimiter",
  field_delimiter: "FieldDelimiter",
  quote_character: "QuoteCharacter",
}

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#field_delimiter ⇒ String

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

Returns:

  • (String) 


843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-s3/types.rb', line 843

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  SENSITIVE = []
  include Aws::Structure
end

#quote_character ⇒ String

A single character used for escaping when the field delimiter is part of the value. For example, if the value is ‘a, b`, Amazon S3 wraps this field value in quotation marks, as follows: `“ a , b ”`.

Returns:

  • (String) 


843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-s3/types.rb', line 843

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  SENSITIVE = []
  include Aws::Structure
end

#quote_escape_character ⇒ String

The single character used for escaping the quote character inside an already escaped value.

Returns:

  • (String) 


843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-s3/types.rb', line 843

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  SENSITIVE = []
  include Aws::Structure
end

#quote_fields ⇒ String

Indicates whether to use quotation marks around output fields.

  • ‘ALWAYS`: Always use quotation marks for output fields.

  • ‘ASNEEDED`: Use quotation marks for output fields when needed.

Returns:

  • (String) 


843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-s3/types.rb', line 843

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  SENSITIVE = []
  include Aws::Structure
end

#record_delimiter ⇒ String

A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

Returns:

  • (String) 


843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-s3/types.rb', line 843

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  SENSITIVE = []
  include Aws::Structure
end