« blib/lib/Paws/Athena/CreateWorkGroupOutput.pm
↑ Summary
blib/lib/Paws/Athena/DataCatalogSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::DataCatalog; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Parameters => (is => 'ro', isa => 'Paws::Athena::ParametersMap'); | ||
| 7 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Athena::DataCatalog | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Athena::DataCatalog object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Description => $value, ..., Type => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::DataCatalog object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Description | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Contains information about a data catalog in an AWS account. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Description => Str | ||
| 45 | |||
| 46 | An optional description of the data catalog. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> Name => Str | ||
| 50 | |||
| 51 | The name of the data catalog. The catalog name must be unique for the | ||
| 52 | AWS account and can use a maximum of 128 alphanumeric, underscore, at | ||
| 53 | sign, or hyphen characters. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Parameters => L<Paws::Athena::ParametersMap> | ||
| 57 | |||
| 58 | Specifies the Lambda function or functions to use for the data catalog. | ||
| 59 | This is a mapping whose values depend on the catalog type. | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | For the C<HIVE> data catalog type, use the following syntax. The | ||
| 66 | C<metadata-function> parameter is required. C<The sdk-version> | ||
| 67 | parameter is optional and defaults to the currently supported version. | ||
| 68 | |||
| 69 | C<metadata-function=I<lambda_arn>, sdk-version=I<version_number>> | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | For the C<LAMBDA> data catalog type, use one of the following sets of | ||
| 74 | required parameters, but not both. | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | If you have one Lambda function that processes metadata and another for | ||
| 81 | reading the actual data, use the following syntax. Both parameters are | ||
| 82 | required. | ||
| 83 | |||
| 84 | C<metadata-function=I<lambda_arn>, record-function=I<lambda_arn>> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | If you have a composite Lambda function that processes both metadata | ||
| 89 | and data, use the following syntax to specify your Lambda function. | ||
| 90 | |||
| 91 | C<function=I<lambda_arn>> | ||
| 92 | |||
| 93 | =back | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Type => Str | ||
| 100 | |||
| 101 | The type of data catalog: C<LAMBDA> for a federated catalog or C<HIVE> | ||
| 102 | for an external hive metastore. C<GLUE> refers to the C<AwsDataCatalog> | ||
| 103 | that already exists in your account, of which you can have only one. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |