Amazonka.Athena.Types.ResultConfigurationUpdates

Documentation

data ResultConfigurationUpdates

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

See: newResultConfigurationUpdates smart constructor.

Constructors

ResultConfigurationUpdates'

Fields

• aclConfiguration :: Maybe AclConfiguration

  The ACL configuration for the query results.

• encryptionConfiguration :: Maybe EncryptionConfiguration

  The encryption configuration for the query results.

• expectedBucketOwner :: Maybe Text

  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.

• outputLocation :: Maybe Text

  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.

• removeAclConfiguration :: Maybe Bool

  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.

• removeEncryptionConfiguration :: Maybe Bool

  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.

• removeExpectedBucketOwner :: Maybe Bool

  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.

• removeOutputLocation :: Maybe Bool

  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.

Instances

ToJSON ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

toJSON :: ResultConfigurationUpdates -> Value

toEncoding :: ResultConfigurationUpdates -> Encoding

toJSONList :: [ResultConfigurationUpdates] -> Value

toEncodingList :: [ResultConfigurationUpdates] -> Encoding

Generic ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Associated Types

type Rep ResultConfigurationUpdates :: Type -> Type

Methods

from :: ResultConfigurationUpdates -> Rep ResultConfigurationUpdates x

to :: Rep ResultConfigurationUpdates x -> ResultConfigurationUpdates

Read ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

readsPrec :: Int -> ReadS ResultConfigurationUpdates

readList :: ReadS [ResultConfigurationUpdates]

readPrec :: ReadPrec ResultConfigurationUpdates

readListPrec :: ReadPrec [ResultConfigurationUpdates]

Show ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

showsPrec :: Int -> ResultConfigurationUpdates -> ShowS

show :: ResultConfigurationUpdates -> String

showList :: [ResultConfigurationUpdates] -> ShowS

NFData ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

rnf :: ResultConfigurationUpdates -> ()

Eq ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

(==) :: ResultConfigurationUpdates -> ResultConfigurationUpdates -> Bool

(/=) :: ResultConfigurationUpdates -> ResultConfigurationUpdates -> Bool

Hashable ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Methods

hashWithSalt :: Int -> ResultConfigurationUpdates -> Int

hash :: ResultConfigurationUpdates -> Int

type Rep ResultConfigurationUpdates

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

type Rep ResultConfigurationUpdates = D1 ('MetaData "ResultConfigurationUpdates" "Amazonka.Athena.Types.ResultConfigurationUpdates" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ResultConfigurationUpdates'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aclConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AclConfiguration)) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration))) :*: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "removeAclConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "removeEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "removeExpectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "removeOutputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newResultConfigurationUpdates :: ResultConfigurationUpdates

Create a value of ResultConfigurationUpdates with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aclConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_aclConfiguration - The ACL configuration for the query results.

$sel:encryptionConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_encryptionConfiguration - The encryption configuration for the query results.

$sel:expectedBucketOwner:ResultConfigurationUpdates', resultConfigurationUpdates_expectedBucketOwner - 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.

$sel:outputLocation:ResultConfigurationUpdates', resultConfigurationUpdates_outputLocation - 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.

$sel:removeAclConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_removeAclConfiguration - 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.

$sel:removeEncryptionConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_removeEncryptionConfiguration - 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.

$sel:removeExpectedBucketOwner:ResultConfigurationUpdates', resultConfigurationUpdates_removeExpectedBucketOwner - 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.

$sel:removeOutputLocation:ResultConfigurationUpdates', resultConfigurationUpdates_removeOutputLocation - 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.

resultConfigurationUpdates_aclConfiguration :: Lens' ResultConfigurationUpdates (Maybe AclConfiguration)

The ACL configuration for the query results.

resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration)

The encryption configuration for the query results.

resultConfigurationUpdates_expectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Text)

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.

resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text)

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.

resultConfigurationUpdates_removeAclConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)

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.

resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)

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.

resultConfigurationUpdates_removeExpectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Bool)

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.

resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool)

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.