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

Inherits:

Struct

• Object
• Struct
• Aws::Athena::Types::ResultConfigurationUpdates

Includes:

Structure

Defined in:

lib/aws-sdk-athena/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #acl_configuration ⇒ Types::AclConfiguration

  The ACL configuration for the query results.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  The encryption configuration for query and calculation results.

• #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.

• #output_location ⇒ String

  The location in Amazon S3 where your query and calculation results are stored, such as ‘s3://path/to/query/bucket/`.

• #remove_acl_configuration ⇒ Boolean

  If set to ‘true`, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.

• #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.

• #remove_expected_bucket_owner ⇒ Boolean

  If set to “true”, removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner.

• #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.

Instance Attribute Details

#acl_configuration ⇒ Types::AclConfiguration

The ACL configuration for the query results.

Returns:

• (Types::AclConfiguration)

# File 'lib/aws-sdk-athena/types.rb', line 3891

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

#encryption_configuration ⇒ Types::EncryptionConfiguration

The encryption configuration for query and calculation results.

Returns:

• (Types::EncryptionConfiguration)

# File 'lib/aws-sdk-athena/types.rb', line 3891

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration,
  :expected_bucket_owner,
  :remove_expected_bucket_owner,
  :acl_configuration,
  :remove_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.

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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration,
  :expected_bucket_owner,
  :remove_expected_bucket_owner,
  :acl_configuration,
  :remove_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/`. 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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

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

#remove_acl_configuration ⇒ Boolean

If set to ‘true`, indicates that the previously-specified ACL configuration 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 `AclConfiguration` of `ResultConfigurationUpdates`, the `AclConfiguration` in the workgroup’s ‘ResultConfiguration` is 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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration,
  :expected_bucket_owner,
  :remove_expected_bucket_owner,
  :acl_configuration,
  :remove_acl_configuration)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

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

#remove_expected_bucket_owner ⇒ Boolean

If set to “true”, removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to “false” or not set, and a value is present in the ‘ExpectedBucketOwner` in `ResultConfigurationUpdates` (the client-side setting), the `ExpectedBucketOwner` in the workgroup’s ‘ResultConfiguration` is 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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

class ResultConfigurationUpdates < Struct.new(
  :output_location,
  :remove_output_location,
  :encryption_configuration,
  :remove_encryption_configuration,
  :expected_bucket_owner,
  :remove_expected_bucket_owner,
  :acl_configuration,
  :remove_acl_configuration)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-athena/types.rb', line 3891

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