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

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