« blib/lib/Paws/Athena/CreateDataCatalogOutput.pm
↑ Summary
blib/lib/Paws/Athena/CreateNamedQueryOutput.pm »
| 1 | |||
| 2 | package Paws::Athena::CreateNamedQuery; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Database => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has QueryString => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has WorkGroup => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNamedQuery'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Athena::CreateNamedQueryOutput'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Athena::CreateNamedQuery - Arguments for method CreateNamedQuery on L<Paws::Athena> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateNamedQuery on the | ||
| 27 | L<Amazon Athena|Paws::Athena> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateNamedQuery. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNamedQuery. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $athena = Paws->service('Athena'); | ||
| 35 | my $CreateNamedQueryOutput = $athena->CreateNamedQuery( | ||
| 36 | Database => 'MyDatabaseString', | ||
| 37 | Name => 'MyNameString', | ||
| 38 | QueryString => 'MyQueryString', | ||
| 39 | ClientRequestToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 40 | Description => 'MyDescriptionString', # OPTIONAL | ||
| 41 | WorkGroup => 'MyWorkGroupName', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $NamedQueryId = $CreateNamedQueryOutput->NamedQueryId; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Athena::CreateNamedQueryOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/athena/CreateNamedQuery> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ClientRequestToken => Str | ||
| 56 | |||
| 57 | A unique case-sensitive string used to ensure the request to create the | ||
| 58 | query is idempotent (executes only once). If another | ||
| 59 | C<CreateNamedQuery> request is received, the same response is returned | ||
| 60 | and another query is not created. If a parameter has changed, for | ||
| 61 | example, the C<QueryString>, an error is returned. | ||
| 62 | |||
| 63 | This token is listed as not required because AWS SDKs (for example the | ||
| 64 | AWS SDK for Java) auto-generate the token for users. If you are not | ||
| 65 | using the AWS SDK or the AWS CLI, you must provide this token or the | ||
| 66 | action will fail. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Database => Str | ||
| 71 | |||
| 72 | The database to which the query belongs. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Description => Str | ||
| 77 | |||
| 78 | The query description. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> Name => Str | ||
| 83 | |||
| 84 | The query name. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> QueryString => Str | ||
| 89 | |||
| 90 | The contents of the query with all query statements. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 WorkGroup => Str | ||
| 95 | |||
| 96 | The name of the workgroup in which the named query is being created. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method CreateNamedQuery 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 |