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