Class: Aws::Athena::Types::ResultConfigurationUpdates

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

Overview

Note:

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

{
  output_location: "String",
  remove_output_location: false,
  encryption_configuration: {
    encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
    kms_key: "String",
  },
  remove_encryption_configuration: false,
}

The information about the updates in the query results, such as output location and encryption configuration for the query results.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_configurationTypes::EncryptionConfiguration

The encryption configuration for the query results.



2036
2037
2038
2039
2040
2041
2042
2043
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2036

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_locationString

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:

  • (String)


2036
2037
2038
2039
2040
2041
2042
2043
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2036

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#remove_encryption_configurationBoolean

If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

Returns:

  • (Boolean)


2036
2037
2038
2039
2040
2041
2042
2043
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2036

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#remove_output_locationBoolean

If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

Returns:

  • (Boolean)


2036
2037
2038
2039
2040
2041
2042
2043
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2036

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration)
  SENSITIVE = []
  include Aws::Structure
end