« blib/lib/Paws/Athena/WorkGroup.pm
↑ Summary
blib/lib/Paws/Athena/WorkGroupConfigurationUpdates.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::WorkGroupConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has BytesScannedCutoffPerQuery => (is => 'ro', isa => 'Int'); | ||
| 5 | has EnforceWorkGroupConfiguration => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EngineVersion => (is => 'ro', isa => 'Paws::Athena::EngineVersion'); | ||
| 7 | has PublishCloudWatchMetricsEnabled => (is => 'ro', isa => 'Bool'); | ||
| 8 | has RequesterPaysEnabled => (is => 'ro', isa => 'Bool'); | ||
| 9 | has ResultConfiguration => (is => 'ro', isa => 'Paws::Athena::ResultConfiguration'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Athena::WorkGroupConfiguration | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Athena::WorkGroupConfiguration object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { BytesScannedCutoffPerQuery => $value, ..., ResultConfiguration => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::WorkGroupConfiguration object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->BytesScannedCutoffPerQuery | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The configuration of the workgroup, which includes the location in | ||
| 42 | Amazon S3 where query results are stored, the encryption option, if | ||
| 43 | any, used for query results, whether the Amazon CloudWatch Metrics are | ||
| 44 | enabled for the workgroup and whether workgroup settings override query | ||
| 45 | settings, and the data usage limits for the amount of data scanned per | ||
| 46 | query or per workgroup. The workgroup settings override is specified in | ||
| 47 | EnforceWorkGroupConfiguration (true/false) in the | ||
| 48 | WorkGroupConfiguration. See | ||
| 49 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 BytesScannedCutoffPerQuery => Int | ||
| 55 | |||
| 56 | The upper data usage limit (cutoff) for the amount of bytes a single | ||
| 57 | query in a workgroup is allowed to scan. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 EnforceWorkGroupConfiguration => Bool | ||
| 61 | |||
| 62 | If set to "true", the settings for the workgroup override client-side | ||
| 63 | settings. If set to "false", client-side settings are used. For more | ||
| 64 | information, see Workgroup Settings Override Client-Side Settings | ||
| 65 | (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EngineVersion => L<Paws::Athena::EngineVersion> | ||
| 69 | |||
| 70 | The engine version that all queries running on the workgroup use. | ||
| 71 | Queries on the C<AmazonAthenaPreviewFunctionality> workgroup run on the | ||
| 72 | preview engine regardless of this setting. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 PublishCloudWatchMetricsEnabled => Bool | ||
| 76 | |||
| 77 | Indicates that the Amazon CloudWatch metrics are enabled for the | ||
| 78 | workgroup. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 RequesterPaysEnabled => Bool | ||
| 82 | |||
| 83 | If set to C<true>, allows members assigned to a workgroup to reference | ||
| 84 | Amazon S3 Requester Pays buckets in queries. If set to C<false>, | ||
| 85 | workgroup members cannot query data from Requester Pays buckets, and | ||
| 86 | queries that retrieve data from Requester Pays buckets cause an error. | ||
| 87 | The default is C<false>. For more information about Requester Pays | ||
| 88 | buckets, see Requester Pays Buckets | ||
| 89 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) | ||
| 90 | in the I<Amazon Simple Storage Service Developer Guide>. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ResultConfiguration => L<Paws::Athena::ResultConfiguration> | ||
| 94 | |||
| 95 | The configuration for the workgroup, which includes the location in | ||
| 96 | Amazon S3 where query results are stored and the encryption option, if | ||
| 97 | any, used for query results. To run the query, you must specify the | ||
| 98 | query results location using one of the ways: either in the workgroup | ||
| 99 | using this setting, or for individual queries (client-side), using | ||
| 100 | ResultConfiguration$OutputLocation. If none of them is set, Athena | ||
| 101 | issues an error that no output location is provided. For more | ||
| 102 | information, see Query Results | ||
| 103 | (https://docs.aws.amazon.com/athena/latest/ug/querying.html). | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |