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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl_configuration ⇒ Types::AclConfiguration

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is ‘BUCKET_OWNER_FULL_CONTROL`. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and [Workgroup Settings Override Client-Side Settings].

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

Returns:



3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/aws-sdk-athena/types.rb', line 3582

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration,
  :expected_bucket_owner,
  :acl_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

If query and calculation 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].

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

Returns:



3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/aws-sdk-athena/types.rb', line 3582

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration,
  :expected_bucket_owner,
  :acl_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ‘ExpectedBucketOwner` when it makes Amazon S3 calls to your specified output location. If the `ExpectedBucketOwner` Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ‘ExpectedBucketOwner` setting 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].

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

Returns:

  • (String) 


3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/aws-sdk-athena/types.rb', line 3582

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration,
  :expected_bucket_owner,
  :acl_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_location ⇒ String

The location in Amazon S3 where your query and calculation 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. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:

  • (String) 


3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/aws-sdk-athena/types.rb', line 3582

class ResultConfiguration < Struct.new(
  :output_location,
  :encryption_configuration,
  :expected_bucket_owner,
  :acl_configuration)
  SENSITIVE = []
  include Aws::Structure
end