| 1 | |||
| 2 | package Paws::Athena::StartQueryExecution; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has QueryExecutionContext => (is => 'ro', isa => 'Paws::Athena::QueryExecutionContext'); | ||
| 6 | has QueryString => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ResultConfiguration => (is => 'ro', isa => 'Paws::Athena::ResultConfiguration'); | ||
| 8 | has WorkGroup => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartQueryExecution'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Athena::StartQueryExecutionOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Athena::StartQueryExecution - Arguments for method StartQueryExecution on L<Paws::Athena> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartQueryExecution on the | ||
| 26 | L<Amazon Athena|Paws::Athena> service. Use the attributes of this class | ||
| 27 | as arguments to method StartQueryExecution. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartQueryExecution. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $athena = Paws->service('Athena'); | ||
| 34 | my $StartQueryExecutionOutput = $athena->StartQueryExecution( | ||
| 35 | QueryString => 'MyQueryString', | ||
| 36 | ClientRequestToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 37 | QueryExecutionContext => { | ||
| 38 | Catalog => 'MyCatalogNameString', # min: 1, max: 256; OPTIONAL | ||
| 39 | Database => 'MyDatabaseString', # min: 1, max: 255; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | ResultConfiguration => { | ||
| 42 | EncryptionConfiguration => { | ||
| 43 | EncryptionOption => 'SSE_S3', # values: SSE_S3, SSE_KMS, CSE_KMS | ||
| 44 | KmsKey => 'MyString', # OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | OutputLocation => 'MyString', # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | WorkGroup => 'MyWorkGroupName', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $QueryExecutionId = $StartQueryExecutionOutput->QueryExecutionId; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Athena::StartQueryExecutionOutput> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/athena/StartQueryExecution> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClientRequestToken => Str | ||
| 63 | |||
| 64 | A unique case-sensitive string used to ensure the request to create the | ||
| 65 | query is idempotent (executes only once). If another | ||
| 66 | C<StartQueryExecution> request is received, the same response is | ||
| 67 | returned and another query is not created. If a parameter has changed, | ||
| 68 | for example, the C<QueryString>, an error is returned. | ||
| 69 | |||
| 70 | This token is listed as not required because AWS SDKs (for example the | ||
| 71 | AWS SDK for Java) auto-generate the token for users. If you are not | ||
| 72 | using the AWS SDK or the AWS CLI, you must provide this token or the | ||
| 73 | action will fail. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 QueryExecutionContext => L<Paws::Athena::QueryExecutionContext> | ||
| 78 | |||
| 79 | The database within which the query executes. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> QueryString => Str | ||
| 84 | |||
| 85 | The SQL query statements to be executed. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 ResultConfiguration => L<Paws::Athena::ResultConfiguration> | ||
| 90 | |||
| 91 | Specifies information about where and how to save the results of the | ||
| 92 | query execution. If the query runs in a workgroup, then workgroup's | ||
| 93 | settings may override query settings. This affects the query results | ||
| 94 | location. The workgroup settings override is specified in | ||
| 95 | EnforceWorkGroupConfiguration (true/false) in the | ||
| 96 | WorkGroupConfiguration. See | ||
| 97 | WorkGroupConfiguration$EnforceWorkGroupConfiguration. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 WorkGroup => Str | ||
| 102 | |||
| 103 | The name of the workgroup in which the query is being started. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method StartQueryExecution 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 |