blib/lib/Paws/Quicksight/CreateDashboard.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::CreateDashboard;
3 use Moose;
4 has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1);
5 has DashboardId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DashboardId', required => 1);
6 has DashboardPublishOptions => (is => 'ro', isa => 'Paws::Quicksight::DashboardPublishOptions');
7 has Name => (is => 'ro', isa => 'Str', required => 1);
8 has Parameters => (is => 'ro', isa => 'Paws::Quicksight::Parameters');
9 has Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]');
10 has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::DashboardSourceEntity', required => 1);
11 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]');
12 has ThemeArn => (is => 'ro', isa => 'Str');
13 has VersionDescription => (is => 'ro', isa => 'Str');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDashboard');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/dashboards/{DashboardId}');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateDashboardResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Quicksight::CreateDashboard - Arguments for method CreateDashboard on L<Paws::Quicksight>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateDashboard on the
32 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
33 as arguments to method CreateDashboard.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDashboard.
36  
37 =head1 SYNOPSIS
38  
39 my $quicksight = Paws->service('Quicksight');
40 my $CreateDashboardResponse = $quicksight->CreateDashboard(
41 AwsAccountId => 'MyAwsAccountId',
42 DashboardId => 'MyRestrictiveResourceId',
43 Name => 'MyDashboardName',
44 SourceEntity => {
45 SourceTemplate => {
46 Arn => 'MyArn',
47 DataSetReferences => [
48 {
49 DataSetArn => 'MyArn',
50 DataSetPlaceholder => 'MyNonEmptyString',
51  
52 },
53 ...
54 ], # min: 1
55  
56 }, # OPTIONAL
57 },
58 DashboardPublishOptions => {
59 AdHocFilteringOption => {
60 AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL
61 }, # OPTIONAL
62 ExportToCSVOption => {
63 AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL
64 }, # OPTIONAL
65 SheetControlsOption => {
66 VisibilityState => 'EXPANDED', # values: EXPANDED, COLLAPSED; OPTIONAL
67 }, # OPTIONAL
68 }, # OPTIONAL
69 Parameters => {
70 DateTimeParameters => [
71 {
72 Name => 'MyNonEmptyString',
73 Values => [ '1970-01-01T01:00:00', ... ],
74  
75 },
76 ...
77 ], # max: 100; OPTIONAL
78 DecimalParameters => [
79 {
80 Name => 'MyNonEmptyString',
81 Values => [ 1, ... ],
82  
83 },
84 ...
85 ], # max: 100; OPTIONAL
86 IntegerParameters => [
87 {
88 Name => 'MyNonEmptyString',
89 Values => [ 1, ... ],
90  
91 },
92 ...
93 ], # max: 100; OPTIONAL
94 StringParameters => [
95 {
96 Name => 'MyNonEmptyString',
97 Values => [ 'MyString', ... ],
98  
99 },
100 ...
101 ], # max: 100; OPTIONAL
102 }, # OPTIONAL
103 Permissions => [
104 {
105 Actions => [ 'MyString', ... ], # min: 1, max: 16
106 Principal => 'MyPrincipal', # min: 1, max: 256
107  
108 },
109 ...
110 ], # OPTIONAL
111 Tags => [
112 {
113 Key => 'MyTagKey', # min: 1, max: 128
114 Value => 'MyTagValue', # min: 1, max: 256
115  
116 },
117 ...
118 ], # OPTIONAL
119 ThemeArn => 'MyArn', # OPTIONAL
120 VersionDescription => 'MyVersionDescription', # OPTIONAL
121 );
122  
123 # Results:
124 my $Arn = $CreateDashboardResponse->Arn;
125 my $CreationStatus = $CreateDashboardResponse->CreationStatus;
126 my $DashboardId = $CreateDashboardResponse->DashboardId;
127 my $RequestId = $CreateDashboardResponse->RequestId;
128 my $Status = $CreateDashboardResponse->Status;
129 my $VersionArn = $CreateDashboardResponse->VersionArn;
130  
131 # Returns a L<Paws::Quicksight::CreateDashboardResponse> object.
132  
133 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.
134 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateDashboard>
135  
136 =head1 ATTRIBUTES
137  
138  
139 =head2 B<REQUIRED> AwsAccountId => Str
140  
141 The ID of the AWS account where you want to create the dashboard.
142  
143  
144  
145 =head2 B<REQUIRED> DashboardId => Str
146  
147 The ID for the dashboard, also added to the IAM policy.
148  
149  
150  
151 =head2 DashboardPublishOptions => L<Paws::Quicksight::DashboardPublishOptions>
152  
153 Options for publishing the dashboard when you create it:
154  
155 =over
156  
157 =item *
158  
159 C<AvailabilityStatus> for C<AdHocFilteringOption> - This status can be
160 either C<ENABLED> or C<DISABLED>. When this is set to C<DISABLED>,
161 QuickSight disables the left filter pane on the published dashboard,
162 which can be used for ad hoc (one-time) filtering. This option is
163 C<ENABLED> by default.
164  
165 =item *
166  
167 C<AvailabilityStatus> for C<ExportToCSVOption> - This status can be
168 either C<ENABLED> or C<DISABLED>. The visual option to export data to
169 .CSV format isn't enabled when this is set to C<DISABLED>. This option
170 is C<ENABLED> by default.
171  
172 =item *
173  
174 C<VisibilityState> for C<SheetControlsOption> - This visibility state
175 can be either C<COLLAPSED> or C<EXPANDED>. This option is C<COLLAPSED>
176 by default.
177  
178 =back
179  
180  
181  
182  
183 =head2 B<REQUIRED> Name => Str
184  
185 The display name of the dashboard.
186  
187  
188  
189 =head2 Parameters => L<Paws::Quicksight::Parameters>
190  
191 The parameters for the creation of the dashboard, which you want to use
192 to override the default settings. A dashboard can have any type of
193 parameters, and some parameters might accept multiple values.
194  
195  
196  
197 =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>]
198  
199 A structure that contains the permissions of the dashboard. You can use
200 this structure for granting permissions by providing a list of IAM
201 action information for each principal ARN.
202  
203 To specify no permissions, omit the permissions list.
204  
205  
206  
207 =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::DashboardSourceEntity>
208  
209 The entity that you are using as a source when you create the
210 dashboard. In C<SourceEntity>, you specify the type of object you're
211 using as source. You can only create a dashboard from a template, so
212 you use a C<SourceTemplate> entity. If you need to create a dashboard
213 from an analysis, first convert the analysis to a template by using the
214 CreateTemplate API operation. For C<SourceTemplate>, specify the Amazon
215 Resource Name (ARN) of the source template. The C<SourceTemplate>ARN
216 can contain any AWS Account and any QuickSight-supported AWS Region.
217  
218 Use the C<DataSetReferences> entity within C<SourceTemplate> to list
219 the replacement datasets for the placeholders listed in the original.
220 The schema in each dataset must match its placeholder.
221  
222  
223  
224 =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>]
225  
226 Contains a map of the key-value pairs for the resource tag or tags
227 assigned to the dashboard.
228  
229  
230  
231 =head2 ThemeArn => Str
232  
233 The Amazon Resource Name (ARN) of the theme that is being used for this
234 dashboard. If you add a value for this field, it overrides the value
235 that is used in the source entity. The theme ARN must exist in the same
236 AWS account where you create the dashboard.
237  
238  
239  
240 =head2 VersionDescription => Str
241  
242 A description for the first version of the dashboard being created.
243  
244  
245  
246  
247 =head1 SEE ALSO
248  
249 This class forms part of L<Paws>, documenting arguments for method CreateDashboard in L<Paws::Quicksight>
250  
251 =head1 BUGS and CONTRIBUTIONS
252  
253 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
254  
255 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
256  
257 =cut
258