Amazonka.Athena.Types.ResultConfiguration

Documentation

data ResultConfiguration

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.

See: newResultConfiguration smart constructor.

Constructors

ResultConfiguration'

Fields

• aclConfiguration :: Maybe 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.

• encryptionConfiguration :: Maybe 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.

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

  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.

• outputLocation :: Maybe Text

  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.

Instances

FromJSON ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

parseJSON :: Value -> Parser ResultConfiguration

parseJSONList :: Value -> Parser [ResultConfiguration]

ToJSON ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

toJSON :: ResultConfiguration -> Value

toEncoding :: ResultConfiguration -> Encoding

toJSONList :: [ResultConfiguration] -> Value

toEncodingList :: [ResultConfiguration] -> Encoding

Generic ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Associated Types

type Rep ResultConfiguration :: Type -> Type

Methods

from :: ResultConfiguration -> Rep ResultConfiguration x

to :: Rep ResultConfiguration x -> ResultConfiguration

Read ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

readsPrec :: Int -> ReadS ResultConfiguration

readList :: ReadS [ResultConfiguration]

readPrec :: ReadPrec ResultConfiguration

readListPrec :: ReadPrec [ResultConfiguration]

Show ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

showsPrec :: Int -> ResultConfiguration -> ShowS

show :: ResultConfiguration -> String

showList :: [ResultConfiguration] -> ShowS

NFData ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

rnf :: ResultConfiguration -> ()

Eq ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

(==) :: ResultConfiguration -> ResultConfiguration -> Bool

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

Hashable ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

hashWithSalt :: Int -> ResultConfiguration -> Int

hash :: ResultConfiguration -> Int

type Rep ResultConfiguration

Defined in Amazonka.Athena.Types.ResultConfiguration

type Rep ResultConfiguration = D1 ('MetaData "ResultConfiguration" "Amazonka.Athena.Types.ResultConfiguration" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ResultConfiguration'" '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)))))

newResultConfiguration :: ResultConfiguration

Create a value of ResultConfiguration 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:ResultConfiguration', resultConfiguration_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.

$sel:encryptionConfiguration:ResultConfiguration', resultConfiguration_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.

$sel:expectedBucketOwner:ResultConfiguration', resultConfiguration_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.

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.

$sel:outputLocation:ResultConfiguration', resultConfiguration_outputLocation - 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.

resultConfiguration_aclConfiguration :: Lens' ResultConfiguration (Maybe 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.

resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe 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.

resultConfiguration_expectedBucketOwner :: Lens' ResultConfiguration (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.

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.

resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text)

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.