| 1 | |||
| 2 | package Paws::Athena::CreateDataCatalog; | ||
| 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 Tags => (is => 'ro', isa => 'ArrayRef[Paws::Athena::Tag]'); | ||
| 8 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataCatalog'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Athena::CreateDataCatalogOutput'); | ||
| 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::CreateDataCatalog - Arguments for method CreateDataCatalog on L<Paws::Athena> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDataCatalog on the | ||
| 26 | L<Amazon Athena|Paws::Athena> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDataCatalog. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataCatalog. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $athena = Paws->service('Athena'); | ||
| 34 | my $CreateDataCatalogOutput = $athena->CreateDataCatalog( | ||
| 35 | Name => 'MyCatalogNameString', | ||
| 36 | Type => 'LAMBDA', | ||
| 37 | Description => 'MyDescriptionString', # OPTIONAL | ||
| 38 | Parameters => { | ||
| 39 | 'MyKeyString' => | ||
| 40 | 'MyParametersMapValue', # key: min: 1, max: 255, value: max: 51200 | ||
| 41 | }, # OPTIONAL | ||
| 42 | Tags => [ | ||
| 43 | { | ||
| 44 | Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL | ||
| 45 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/athena/CreateDataCatalog> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Description => Str | ||
| 58 | |||
| 59 | A description of the data catalog to be created. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Name => Str | ||
| 64 | |||
| 65 | The name of the data catalog to create. The catalog name must be unique | ||
| 66 | for the AWS account and can use a maximum of 128 alphanumeric, | ||
| 67 | underscore, at sign, or hyphen characters. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Parameters => L<Paws::Athena::ParametersMap> | ||
| 72 | |||
| 73 | Specifies the Lambda function or functions to use for creating the data | ||
| 74 | catalog. This is a mapping whose values depend on the catalog type. | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | For the C<HIVE> data catalog type, use the following syntax. The | ||
| 81 | C<metadata-function> parameter is required. C<The sdk-version> | ||
| 82 | parameter is optional and defaults to the currently supported version. | ||
| 83 | |||
| 84 | C<metadata-function=I<lambda_arn>, sdk-version=I<version_number>> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | For the C<LAMBDA> data catalog type, use one of the following sets of | ||
| 89 | required parameters, but not both. | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | If you have one Lambda function that processes metadata and another for | ||
| 96 | reading the actual data, use the following syntax. Both parameters are | ||
| 97 | required. | ||
| 98 | |||
| 99 | C<metadata-function=I<lambda_arn>, record-function=I<lambda_arn>> | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | If you have a composite Lambda function that processes both metadata | ||
| 104 | and data, use the following syntax to specify your Lambda function. | ||
| 105 | |||
| 106 | C<function=I<lambda_arn>> | ||
| 107 | |||
| 108 | =back | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 Tags => ArrayRef[L<Paws::Athena::Tag>] | ||
| 116 | |||
| 117 | A list of comma separated tags to add to the data catalog that is | ||
| 118 | created. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> Type => Str | ||
| 123 | |||
| 124 | The type of data catalog to create: C<LAMBDA> for a federated catalog | ||
| 125 | or C<HIVE> for an external hive metastore. | ||
| 126 | |||
| 127 | Do not use the C<GLUE> type. This refers to the C<AwsDataCatalog> that | ||
| 128 | already exists in your account, of which you can have only one. | ||
| 129 | Specifying the C<GLUE> type will result in an C<INVALID_INPUT> error. | ||
| 130 | |||
| 131 | Valid values are: C<"LAMBDA">, C<"GLUE">, C<"HIVE"> | ||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method CreateDataCatalog in L<Paws::Athena> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |