blib/lib/Paws/Quicksight/CreateDataSet.pm untested

filter: Statementstmt 0.0% 0 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 25 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Quicksight::CreateDataSet;
3 use Moose;
4 has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1);
5 has ColumnGroups => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ColumnGroup]');
6 has ColumnLevelPermissionRules => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ColumnLevelPermissionRule]');
7 has DataSetId => (is => 'ro', isa => 'Str', required => 1);
8 has FieldFolders => (is => 'ro', isa => 'Paws::Quicksight::FieldFolderMap');
9 has ImportMode => (is => 'ro', isa => 'Str', required => 1);
10 has LogicalTableMap => (is => 'ro', isa => 'Paws::Quicksight::LogicalTableMap');
11 has Name => (is => 'ro', isa => 'Str', required => 1);
12 has Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]');
13 has PhysicalTableMap => (is => 'ro', isa => 'Paws::Quicksight::PhysicalTableMap', required => 1);
14 has RowLevelPermissionDataSet => (is => 'ro', isa => 'Paws::Quicksight::RowLevelPermissionDataSet');
15 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]');
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataSet');
20 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/data-sets');
21 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateDataSetResponse');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::Quicksight::CreateDataSet - Arguments for method CreateDataSet on L<Paws::Quicksight>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method CreateDataSet on the
34 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
35 as arguments to method CreateDataSet.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSet.
38  
39 =head1 SYNOPSIS
40  
41 my $quicksight = Paws->service('Quicksight');
42 my $CreateDataSetResponse = $quicksight->CreateDataSet(
43 AwsAccountId => 'MyAwsAccountId',
44 DataSetId => 'MyResourceId',
45 ImportMode => 'SPICE',
46 Name => 'MyResourceName',
47 PhysicalTableMap => {
48 'MyPhysicalTableId' => {
49 CustomSql => {
50 DataSourceArn => 'MyArn',
51 Name => 'MyCustomSqlName', # min: 1, max: 64
52 SqlQuery => 'MySqlQuery', # min: 1, max: 65536
53 Columns => [
54 {
55 Name => 'MyColumnName', # min: 1, max: 128
56 Type => 'STRING'
57 , # values: STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
58  
59 },
60 ...
61 ], # min: 1, max: 2048; OPTIONAL
62 }, # OPTIONAL
63 RelationalTable => {
64 DataSourceArn => 'MyArn',
65 InputColumns => [
66 {
67 Name => 'MyColumnName', # min: 1, max: 128
68 Type => 'STRING'
69 , # values: STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
70  
71 },
72 ...
73 ], # min: 1, max: 2048; OPTIONAL
74 Name => 'MyRelationalTableName', # min: 1, max: 64
75 Catalog => 'MyRelationalTableCatalog', # max: 256; OPTIONAL
76 Schema => 'MyRelationalTableSchema', # max: 64; OPTIONAL
77 }, # OPTIONAL
78 S3Source => {
79 DataSourceArn => 'MyArn',
80 InputColumns => [
81 {
82 Name => 'MyColumnName', # min: 1, max: 128
83 Type => 'STRING'
84 , # values: STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
85  
86 },
87 ...
88 ], # min: 1, max: 2048; OPTIONAL
89 UploadSettings => {
90 ContainsHeader => 1, # OPTIONAL
91 Delimiter => 'MyDelimiter', # min: 1, max: 1; OPTIONAL
92 Format =>
93 'CSV', # values: CSV, TSV, CLF, ELF, XLSX, JSON; OPTIONAL
94 StartFromRow => 1, # min: 1; OPTIONAL
95 TextQualifier =>
96 'DOUBLE_QUOTE', # values: DOUBLE_QUOTE, SINGLE_QUOTE; OPTIONAL
97 }, # OPTIONAL
98 }, # OPTIONAL
99 }, # key: min: 1, max: 64
100 },
101 ColumnGroups => [
102 {
103 GeoSpatialColumnGroup => {
104 Columns => [
105 'MyColumnName', ... # min: 1, max: 128
106 ], # min: 1, max: 16
107 CountryCode => 'US', # values: US
108 Name => 'MyColumnGroupName', # min: 1, max: 64
109  
110 }, # OPTIONAL
111 },
112 ...
113 ], # OPTIONAL
114 ColumnLevelPermissionRules => [
115 {
116 ColumnNames => [ 'MyString', ... ], # min: 1; OPTIONAL
117 Principals => [ 'MyString', ... ], # min: 1, max: 100; OPTIONAL
118 },
119 ...
120 ], # OPTIONAL
121 FieldFolders => {
122 'MyFieldFolderPath' => {
123 Columns => [ 'MyString', ... ], # max: 5000; OPTIONAL
124 Description => 'MyFieldFolderDescription', # max: 500; OPTIONAL
125 }, # key: min: 1, max: 1000
126 }, # OPTIONAL
127 LogicalTableMap => {
128 'MyLogicalTableId' => {
129 Alias => 'MyLogicalTableAlias', # min: 1, max: 64
130 Source => {
131 JoinInstruction => {
132 LeftOperand => 'MyLogicalTableId', # min: 1, max: 64
133 OnClause => 'MyOnClause', # min: 1, max: 512
134 RightOperand => 'MyLogicalTableId', # min: 1, max: 64
135 Type => 'INNER', # values: INNER, OUTER, LEFT, RIGHT
136 LeftJoinKeyProperties => {
137 UniqueKey => 1, # OPTIONAL
138 }, # OPTIONAL
139 RightJoinKeyProperties => {
140 UniqueKey => 1, # OPTIONAL
141 }, # OPTIONAL
142 }, # OPTIONAL
143 PhysicalTableId => 'MyPhysicalTableId', # min: 1, max: 64
144 },
145 DataTransforms => [
146 {
147 CastColumnTypeOperation => {
148 ColumnName => 'MyColumnName', # min: 1, max: 128
149 NewColumnType =>
150 'STRING', # values: STRING, INTEGER, DECIMAL, DATETIME
151 Format => 'MyTypeCastFormat', # max: 32; OPTIONAL
152 }, # OPTIONAL
153 CreateColumnsOperation => {
154 Columns => [
155 {
156 ColumnId => 'MyColumnId', # min: 1, max: 64
157 ColumnName => 'MyColumnName', # min: 1, max: 128
158 Expression => 'MyExpression', # min: 1, max: 4096
159  
160 },
161 ...
162 ], # min: 1, max: 128
163  
164 }, # OPTIONAL
165 FilterOperation => {
166 ConditionExpression => 'MyExpression', # min: 1, max: 4096
167  
168 }, # OPTIONAL
169 ProjectOperation => {
170 ProjectedColumns => [ 'MyString', ... ], # min: 1, max: 2000
171  
172 }, # OPTIONAL
173 RenameColumnOperation => {
174 ColumnName => 'MyColumnName', # min: 1, max: 128
175 NewColumnName => 'MyColumnName', # min: 1, max: 128
176  
177 }, # OPTIONAL
178 TagColumnOperation => {
179 ColumnName => 'MyColumnName', # min: 1, max: 128
180 Tags => [
181 {
182 ColumnDescription => {
183 Text => 'MyColumnDescriptiveText', # max: 500; OPTIONAL
184 }, # OPTIONAL
185 ColumnGeographicRole => 'COUNTRY'
186 , # values: COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE; OPTIONAL
187 },
188 ...
189 ], # min: 1, max: 16
190  
191 }, # OPTIONAL
192 },
193 ...
194 ], # min: 1, max: 2048; OPTIONAL
195 }, # key: min: 1, max: 64
196 }, # OPTIONAL
197 Permissions => [
198 {
199 Actions => [ 'MyString', ... ], # min: 1, max: 16
200 Principal => 'MyPrincipal', # min: 1, max: 256
201  
202 },
203 ...
204 ], # OPTIONAL
205 RowLevelPermissionDataSet => {
206 Arn => 'MyArn',
207 PermissionPolicy => 'GRANT_ACCESS', # values: GRANT_ACCESS, DENY_ACCESS
208 FormatVersion => 'VERSION_1', # values: VERSION_1, VERSION_2; OPTIONAL
209 Namespace => 'MyNamespace', # max: 64; OPTIONAL
210 }, # OPTIONAL
211 Tags => [
212 {
213 Key => 'MyTagKey', # min: 1, max: 128
214 Value => 'MyTagValue', # min: 1, max: 256
215  
216 },
217 ...
218 ], # OPTIONAL
219 );
220  
221 # Results:
222 my $Arn = $CreateDataSetResponse->Arn;
223 my $DataSetId = $CreateDataSetResponse->DataSetId;
224 my $IngestionArn = $CreateDataSetResponse->IngestionArn;
225 my $IngestionId = $CreateDataSetResponse->IngestionId;
226 my $RequestId = $CreateDataSetResponse->RequestId;
227 my $Status = $CreateDataSetResponse->Status;
228  
229 # Returns a L<Paws::Quicksight::CreateDataSetResponse> object.
230  
231 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.
232 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateDataSet>
233  
234 =head1 ATTRIBUTES
235  
236  
237 =head2 B<REQUIRED> AwsAccountId => Str
238  
239 The AWS account ID.
240  
241  
242  
243 =head2 ColumnGroups => ArrayRef[L<Paws::Quicksight::ColumnGroup>]
244  
245 Groupings of columns that work together in certain QuickSight features.
246 Currently, only geospatial hierarchy is supported.
247  
248  
249  
250 =head2 ColumnLevelPermissionRules => ArrayRef[L<Paws::Quicksight::ColumnLevelPermissionRule>]
251  
252 A set of one or more definitions of a C< ColumnLevelPermissionRule >.
253  
254  
255  
256 =head2 B<REQUIRED> DataSetId => Str
257  
258 An ID for the dataset that you want to create. This ID is unique per
259 AWS Region for each AWS account.
260  
261  
262  
263 =head2 FieldFolders => L<Paws::Quicksight::FieldFolderMap>
264  
265 The folder that contains fields and nested subfolders for your dataset.
266  
267  
268  
269 =head2 B<REQUIRED> ImportMode => Str
270  
271 Indicates whether you want to import the data into SPICE.
272  
273 Valid values are: C<"SPICE">, C<"DIRECT_QUERY">
274  
275 =head2 LogicalTableMap => L<Paws::Quicksight::LogicalTableMap>
276  
277 Configures the combination and transformation of the data from the
278 physical tables.
279  
280  
281  
282 =head2 B<REQUIRED> Name => Str
283  
284 The display name for the dataset.
285  
286  
287  
288 =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>]
289  
290 A list of resource permissions on the dataset.
291  
292  
293  
294 =head2 B<REQUIRED> PhysicalTableMap => L<Paws::Quicksight::PhysicalTableMap>
295  
296 Declares the physical tables that are available in the underlying data
297 sources.
298  
299  
300  
301 =head2 RowLevelPermissionDataSet => L<Paws::Quicksight::RowLevelPermissionDataSet>
302  
303 The row-level security configuration for the data that you want to
304 create.
305  
306  
307  
308 =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>]
309  
310 Contains a map of the key-value pairs for the resource tag or tags
311 assigned to the dataset.
312  
313  
314  
315  
316 =head1 SEE ALSO
317  
318 This class forms part of L<Paws>, documenting arguments for method CreateDataSet in L<Paws::Quicksight>
319  
320 =head1 BUGS and CONTRIBUTIONS
321  
322 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
323  
324 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
325  
326 =cut
327