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: "ResultOutputLocation",
  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,
  expected_bucket_owner: "AwsAccountId",
  remove_expected_bucket_owner: false,
  acl_configuration: {
    s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
  },
  remove_acl_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

#acl_configurationTypes::AclConfiguration

The ACL configuration for the query results.



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_configurationTypes::EncryptionConfiguration

The encryption configuration for the query results.



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_ownerString

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.

Returns:

  • (String)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_configurationBoolean

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.

Returns:

  • (Boolean)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_ownerBoolean

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.

Returns:

  • (Boolean)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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_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)


2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2522

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