« blib/lib/Paws/Athena/QueryExecutionStatus.pm
↑ Summary
blib/lib/Paws/Athena/ResultConfigurationUpdates.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::ResultConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has EncryptionConfiguration => (is => 'ro', isa => 'Paws::Athena::EncryptionConfiguration'); | ||
| 5 | has OutputLocation => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Athena::ResultConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Athena::ResultConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EncryptionConfiguration => $value, ..., OutputLocation => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::ResultConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EncryptionConfiguration | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The location in Amazon S3 where query results are stored and the | ||
| 38 | encryption option, if any, used for query results. These are known as | ||
| 39 | "client-side settings". If workgroup settings override client-side | ||
| 40 | settings, then the query uses the workgroup settings. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 EncryptionConfiguration => L<Paws::Athena::EncryptionConfiguration> | ||
| 46 | |||
| 47 | If query results are encrypted in Amazon S3, indicates the encryption | ||
| 48 | option used (for example, C<SSE-KMS> or C<CSE-KMS>) and key | ||
| 49 | information. This is a client-side setting. If workgroup settings | ||
| 50 | override client-side settings, then the query uses the encryption | ||
| 51 | configuration that is specified for the workgroup, and also uses the | ||
| 52 | location for storing query results specified in the workgroup. See | ||
| 53 | WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup | ||
| 54 | Settings Override Client-Side Settings | ||
| 55 | (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 OutputLocation => Str | ||
| 59 | |||
| 60 | The location in Amazon S3 where your query results are stored, such as | ||
| 61 | C<s3://path/to/query/bucket/>. To run the query, you must specify the | ||
| 62 | query results location using one of the ways: either for individual | ||
| 63 | queries using either this setting (client-side), or in the workgroup, | ||
| 64 | using WorkGroupConfiguration. If none of them is set, Athena issues an | ||
| 65 | error that no output location is provided. For more information, see | ||
| 66 | Query Results | ||
| 67 | (https://docs.aws.amazon.com/athena/latest/ug/querying.html). If | ||
| 68 | workgroup settings override client-side settings, then the query uses | ||
| 69 | the settings specified for the workgroup. See | ||
| 70 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |