You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Athena::Types::ResultConfiguration

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 ResultConfiguration data as a hash:

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

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_configurationTypes::EncryptionConfiguration

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.



975
976
977
978
979
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 975

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration)
  include Aws::Structure
end

#output_locationString

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:

  • (String)


975
976
977
978
979
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 975

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration)
  include Aws::Structure
end