AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::Model::ResultConfiguration Class Reference

#include <ResultConfiguration.h>

Public Member Functions

 ResultConfiguration ()
 
 ResultConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ResultConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const Aws::String &value)
 
void SetOutputLocation (Aws::String &&value)
 
void SetOutputLocation (const char *value)
 
ResultConfigurationWithOutputLocation (const Aws::String &value)
 
ResultConfigurationWithOutputLocation (Aws::String &&value)
 
ResultConfigurationWithOutputLocation (const char *value)
 
const EncryptionConfigurationGetEncryptionConfiguration () const
 
bool EncryptionConfigurationHasBeenSet () const
 
void SetEncryptionConfiguration (const EncryptionConfiguration &value)
 
void SetEncryptionConfiguration (EncryptionConfiguration &&value)
 
ResultConfigurationWithEncryptionConfiguration (const EncryptionConfiguration &value)
 
ResultConfigurationWithEncryptionConfiguration (EncryptionConfiguration &&value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 35 of file ResultConfiguration.h.

Constructor & Destructor Documentation

◆ ResultConfiguration() [1/2]

Aws::Athena::Model::ResultConfiguration::ResultConfiguration ( )

◆ ResultConfiguration() [2/2]

Aws::Athena::Model::ResultConfiguration::ResultConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EncryptionConfigurationHasBeenSet()

bool Aws::Athena::Model::ResultConfiguration::EncryptionConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 181 of file ResultConfiguration.h.

◆ GetEncryptionConfiguration()

const EncryptionConfiguration& Aws::Athena::Model::ResultConfiguration::GetEncryptionConfiguration ( ) const
inline

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.

Definition at line 168 of file ResultConfiguration.h.

◆ GetOutputLocation()

const Aws::String& Aws::Athena::Model::ResultConfiguration::GetOutputLocation ( ) const
inline

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.

Definition at line 56 of file ResultConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Athena::Model::ResultConfiguration::Jsonize ( ) const

◆ operator=()

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputLocationHasBeenSet()

bool Aws::Athena::Model::ResultConfiguration::OutputLocationHasBeenSet ( ) const
inline

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.

Definition at line 70 of file ResultConfiguration.h.

◆ SetEncryptionConfiguration() [1/2]

void Aws::Athena::Model::ResultConfiguration::SetEncryptionConfiguration ( const EncryptionConfiguration value)
inline

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.

Definition at line 194 of file ResultConfiguration.h.

◆ SetEncryptionConfiguration() [2/2]

void Aws::Athena::Model::ResultConfiguration::SetEncryptionConfiguration ( EncryptionConfiguration &&  value)
inline

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.

Definition at line 207 of file ResultConfiguration.h.

◆ SetOutputLocation() [1/3]

void Aws::Athena::Model::ResultConfiguration::SetOutputLocation ( Aws::String &&  value)
inline

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.

Definition at line 98 of file ResultConfiguration.h.

◆ SetOutputLocation() [2/3]

void Aws::Athena::Model::ResultConfiguration::SetOutputLocation ( const Aws::String value)
inline

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.

Definition at line 84 of file ResultConfiguration.h.

◆ SetOutputLocation() [3/3]

void Aws::Athena::Model::ResultConfiguration::SetOutputLocation ( const char *  value)
inline

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.

Definition at line 112 of file ResultConfiguration.h.

◆ WithEncryptionConfiguration() [1/2]

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::WithEncryptionConfiguration ( const EncryptionConfiguration value)
inline

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.

Definition at line 220 of file ResultConfiguration.h.

◆ WithEncryptionConfiguration() [2/2]

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::WithEncryptionConfiguration ( EncryptionConfiguration &&  value)
inline

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.

Definition at line 233 of file ResultConfiguration.h.

◆ WithOutputLocation() [1/3]

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::WithOutputLocation ( Aws::String &&  value)
inline

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.

Definition at line 140 of file ResultConfiguration.h.

◆ WithOutputLocation() [2/3]

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::WithOutputLocation ( const Aws::String value)
inline

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.

Definition at line 126 of file ResultConfiguration.h.

◆ WithOutputLocation() [3/3]

ResultConfiguration& Aws::Athena::Model::ResultConfiguration::WithOutputLocation ( const char *  value)
inline

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.

Definition at line 154 of file ResultConfiguration.h.


The documentation for this class was generated from the following file: