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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_configuration ⇒ Types::EncryptionConfiguration

The encryption configuration for the query results.

Returns:



1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/aws-sdk-athena/types.rb', line 1001

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

#output_location ⇒ String

The location in Amazon S3 where your query results are stored, such as ‘s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files.] 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.

[1]: docs.aws.amazon.com/athena/latest/ug/querying.html

Returns:

  • (String) 


1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/aws-sdk-athena/types.rb', line 1001

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

#remove_encryption_configuration ⇒ Boolean

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].

[1]: docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html

Returns:

  • (Boolean) 


1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/aws-sdk-athena/types.rb', line 1001

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

#remove_output_location ⇒ Boolean

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].

[1]: docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html

Returns:

  • (Boolean) 


1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/aws-sdk-athena/types.rb', line 1001

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