Class: Aws::GlueDataBrew::Types::UpdateDatasetRequest

Inherits:

Struct

• Object
• Struct
• Aws::GlueDataBrew::Types::UpdateDatasetRequest

Defined in:

gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Note:

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

{
  name: "DatasetName", # required
  format: "CSV", # accepts CSV, JSON, PARQUET, EXCEL, ORC
  format_options: {
    json: {
      multi_line: false,
    },
    excel: {
      sheet_names: ["SheetName"],
      sheet_indexes: [1],
      header_row: false,
    },
    csv: {
      delimiter: "Delimiter",
      header_row: false,
    },
  },
  input: { # required
    s3_input_definition: {
      bucket: "Bucket", # required
      key: "Key",
      bucket_owner: "BucketOwner",
    },
    data_catalog_input_definition: {
      catalog_id: "CatalogId",
      database_name: "DatabaseName", # required
      table_name: "TableName", # required
      temp_directory: {
        bucket: "Bucket", # required
        key: "Key",
        bucket_owner: "BucketOwner",
      },
    },
    database_input_definition: {
      glue_connection_name: "GlueConnectionName", # required
      database_table_name: "DatabaseTableName",
      temp_directory: {
        bucket: "Bucket", # required
        key: "Key",
        bucket_owner: "BucketOwner",
      },
      query_string: "QueryString",
    },
    metadata: {
      source_arn: "Arn",
    },
  },
  path_options: {
    last_modified_date_condition: {
      expression: "Expression", # required
      values_map: { # required
        "ValueReference" => "ConditionValue",
      },
    },
    files_limit: {
      max_files: 1, # required
      ordered_by: "LAST_MODIFIED_DATE", # accepts LAST_MODIFIED_DATE
      order: "DESCENDING", # accepts DESCENDING, ASCENDING
    },
    parameters: {
      "PathParameterName" => {
        name: "PathParameterName", # required
        type: "Datetime", # required, accepts Datetime, Number, String
        datetime_options: {
          format: "DatetimeFormat", # required
          timezone_offset: "TimezoneOffset",
          locale_code: "LocaleCode",
        },
        create_column: false,
        filter: {
          expression: "Expression", # required
          values_map: { # required
            "ValueReference" => "ConditionValue",
          },
        },
      },
    },
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #format ⇒ String

  The file format of a dataset that is created from an Amazon S3 file or folder.

• #format_options ⇒ Types::FormatOptions

  Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

• #input ⇒ Types::Input

  Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.

• #name ⇒ String

  The name of the dataset to be updated.

• #path_options ⇒ Types::PathOptions

  A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

Instance Attribute Details

#format ⇒ String

The file format of a dataset that is created from an Amazon S3 file or folder.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4994

class UpdateDatasetRequest < Struct.new(
  :name,
  :format,
  :format_options,
  :input,
  :path_options)
  SENSITIVE = []
  include Aws::Structure
end

#format_options ⇒ Types::FormatOptions

Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

Returns:

• (Types::FormatOptions)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4994

class UpdateDatasetRequest < Struct.new(
  :name,
  :format,
  :format_options,
  :input,
  :path_options)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ Types::Input

Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.

Returns:

• (Types::Input)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4994

class UpdateDatasetRequest < Struct.new(
  :name,
  :format,
  :format_options,
  :input,
  :path_options)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the dataset to be updated.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4994

class UpdateDatasetRequest < Struct.new(
  :name,
  :format,
  :format_options,
  :input,
  :path_options)
  SENSITIVE = []
  include Aws::Structure
end

#path_options ⇒ Types::PathOptions

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

Returns:

• (Types::PathOptions)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4994

class UpdateDatasetRequest < Struct.new(
  :name,
  :format,
  :format_options,
  :input,
  :path_options)
  SENSITIVE = []
  include Aws::Structure
end