« blib/lib/Paws/Athena/UpdateWorkGroupOutput.pm
↑ Summary
blib/lib/Paws/Athena/WorkGroupConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::WorkGroup; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'Paws::Athena::WorkGroupConfiguration'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has State => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Athena::WorkGroup | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Athena::WorkGroup object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Configuration => $value, ..., State => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::WorkGroup object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Configuration | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A workgroup, which contains a name, description, creation time, state, | ||
| 41 | and other configuration, listed under WorkGroup$Configuration. Each | ||
| 42 | workgroup enables you to isolate queries for you or your group of users | ||
| 43 | from other queries in the same account, to configure the query results | ||
| 44 | location and the encryption configuration (known as workgroup | ||
| 45 | settings), to enable sending query metrics to Amazon CloudWatch, and to | ||
| 46 | establish per-query data usage control limits for all queries in a | ||
| 47 | workgroup. The workgroup settings override is specified in | ||
| 48 | EnforceWorkGroupConfiguration (true/false) in the | ||
| 49 | WorkGroupConfiguration. See | ||
| 50 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Configuration => L<Paws::Athena::WorkGroupConfiguration> | ||
| 56 | |||
| 57 | The configuration of the workgroup, which includes the location in | ||
| 58 | Amazon S3 where query results are stored, the encryption configuration, | ||
| 59 | if any, used for query results; whether the Amazon CloudWatch Metrics | ||
| 60 | are enabled for the workgroup; whether workgroup settings override | ||
| 61 | client-side settings; and the data usage limits for the amount of data | ||
| 62 | scanned per query or per workgroup. The workgroup settings override is | ||
| 63 | specified in EnforceWorkGroupConfiguration (true/false) in the | ||
| 64 | WorkGroupConfiguration. See | ||
| 65 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CreationTime => Str | ||
| 69 | |||
| 70 | The date and time the workgroup was created. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Description => Str | ||
| 74 | |||
| 75 | The workgroup description. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> Name => Str | ||
| 79 | |||
| 80 | The workgroup name. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 State => Str | ||
| 84 | |||
| 85 | The state of the workgroup: ENABLED or DISABLED. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |