« blib/lib/Paws/Athena/CreatePreparedStatementOutput.pm
↑ Summary
blib/lib/Paws/Athena/CreateWorkGroupOutput.pm »
| 1 | |||
| 2 | package Paws::Athena::CreateWorkGroup; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'Paws::Athena::WorkGroupConfiguration'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Athena::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateWorkGroup'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Athena::CreateWorkGroupOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Athena::CreateWorkGroup - Arguments for method CreateWorkGroup on L<Paws::Athena> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateWorkGroup on the | ||
| 25 | L<Amazon Athena|Paws::Athena> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateWorkGroup. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateWorkGroup. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $athena = Paws->service('Athena'); | ||
| 33 | my $CreateWorkGroupOutput = $athena->CreateWorkGroup( | ||
| 34 | Name => 'MyWorkGroupName', | ||
| 35 | Configuration => { | ||
| 36 | BytesScannedCutoffPerQuery => 1, # min: 10000000; OPTIONAL | ||
| 37 | EnforceWorkGroupConfiguration => 1, # OPTIONAL | ||
| 38 | EngineVersion => { | ||
| 39 | EffectiveEngineVersion => 'MyNameString', # min: 1, max: 128; OPTIONAL | ||
| 40 | SelectedEngineVersion => 'MyNameString', # min: 1, max: 128; OPTIONAL | ||
| 41 | }, # OPTIONAL | ||
| 42 | PublishCloudWatchMetricsEnabled => 1, # OPTIONAL | ||
| 43 | RequesterPaysEnabled => 1, # OPTIONAL | ||
| 44 | ResultConfiguration => { | ||
| 45 | EncryptionConfiguration => { | ||
| 46 | EncryptionOption => 'SSE_S3', # values: SSE_S3, SSE_KMS, CSE_KMS | ||
| 47 | KmsKey => 'MyString', # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | OutputLocation => 'MyString', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | Description => 'MyWorkGroupDescriptionString', # OPTIONAL | ||
| 53 | Tags => [ | ||
| 54 | { | ||
| 55 | Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL | ||
| 56 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], # OPTIONAL | ||
| 60 | ); | ||
| 61 | |||
| 62 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/athena/CreateWorkGroup> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Configuration => L<Paws::Athena::WorkGroupConfiguration> | ||
| 69 | |||
| 70 | The configuration for the workgroup, which includes the location in | ||
| 71 | Amazon S3 where query results are stored, the encryption configuration, | ||
| 72 | if any, used for encrypting query results, whether the Amazon | ||
| 73 | CloudWatch Metrics are enabled for the workgroup, the limit for the | ||
| 74 | amount of bytes scanned (cutoff) per query, if it is specified, and | ||
| 75 | whether workgroup's settings (specified with | ||
| 76 | EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override | ||
| 77 | client-side settings. See | ||
| 78 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Description => Str | ||
| 83 | |||
| 84 | The workgroup description. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> Name => Str | ||
| 89 | |||
| 90 | The workgroup name. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 Tags => ArrayRef[L<Paws::Athena::Tag>] | ||
| 95 | |||
| 96 | A list of comma separated tags to add to the workgroup that is created. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method CreateWorkGroup in L<Paws::Athena> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |