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

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Quicksight::CreateAnalysis;
3 use Moose;
4 has AnalysisId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AnalysisId', required => 1);
5 has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1);
6 has Name => (is => 'ro', isa => 'Str', required => 1);
7 has Parameters => (is => 'ro', isa => 'Paws::Quicksight::Parameters');
8 has Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]');
9 has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::AnalysisSourceEntity', required => 1);
10 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]');
11 has ThemeArn => (is => 'ro', isa => 'Str');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAnalysis');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/analyses/{AnalysisId}');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateAnalysisResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::Quicksight::CreateAnalysis - Arguments for method CreateAnalysis on L<Paws::Quicksight>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreateAnalysis on the
30 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
31 as arguments to method CreateAnalysis.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAnalysis.
34  
35 =head1 SYNOPSIS
36  
37 my $quicksight = Paws->service('Quicksight');
38 my $CreateAnalysisResponse = $quicksight->CreateAnalysis(
39 AnalysisId => 'MyRestrictiveResourceId',
40 AwsAccountId => 'MyAwsAccountId',
41 Name => 'MyAnalysisName',
42 SourceEntity => {
43 SourceTemplate => {
44 Arn => 'MyArn',
45 DataSetReferences => [
46 {
47 DataSetArn => 'MyArn',
48 DataSetPlaceholder => 'MyNonEmptyString',
49  
50 },
51 ...
52 ], # min: 1
53  
54 }, # OPTIONAL
55 },
56 Parameters => {
57 DateTimeParameters => [
58 {
59 Name => 'MyNonEmptyString',
60 Values => [ '1970-01-01T01:00:00', ... ],
61  
62 },
63 ...
64 ], # max: 100; OPTIONAL
65 DecimalParameters => [
66 {
67 Name => 'MyNonEmptyString',
68 Values => [ 1, ... ],
69  
70 },
71 ...
72 ], # max: 100; OPTIONAL
73 IntegerParameters => [
74 {
75 Name => 'MyNonEmptyString',
76 Values => [ 1, ... ],
77  
78 },
79 ...
80 ], # max: 100; OPTIONAL
81 StringParameters => [
82 {
83 Name => 'MyNonEmptyString',
84 Values => [ 'MyString', ... ],
85  
86 },
87 ...
88 ], # max: 100; OPTIONAL
89 }, # OPTIONAL
90 Permissions => [
91 {
92 Actions => [ 'MyString', ... ], # min: 1, max: 16
93 Principal => 'MyPrincipal', # min: 1, max: 256
94  
95 },
96 ...
97 ], # OPTIONAL
98 Tags => [
99 {
100 Key => 'MyTagKey', # min: 1, max: 128
101 Value => 'MyTagValue', # min: 1, max: 256
102  
103 },
104 ...
105 ], # OPTIONAL
106 ThemeArn => 'MyArn', # OPTIONAL
107 );
108  
109 # Results:
110 my $AnalysisId = $CreateAnalysisResponse->AnalysisId;
111 my $Arn = $CreateAnalysisResponse->Arn;
112 my $CreationStatus = $CreateAnalysisResponse->CreationStatus;
113 my $RequestId = $CreateAnalysisResponse->RequestId;
114 my $Status = $CreateAnalysisResponse->Status;
115  
116 # Returns a L<Paws::Quicksight::CreateAnalysisResponse> object.
117  
118 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.
119 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateAnalysis>
120  
121 =head1 ATTRIBUTES
122  
123  
124 =head2 B<REQUIRED> AnalysisId => Str
125  
126 The ID for the analysis that you're creating. This ID displays in the
127 URL of the analysis.
128  
129  
130  
131 =head2 B<REQUIRED> AwsAccountId => Str
132  
133 The ID of the AWS account where you are creating an analysis.
134  
135  
136  
137 =head2 B<REQUIRED> Name => Str
138  
139 A descriptive name for the analysis that you're creating. This name
140 displays for the analysis in the QuickSight console.
141  
142  
143  
144 =head2 Parameters => L<Paws::Quicksight::Parameters>
145  
146 The parameter names and override values that you want to use. An
147 analysis can have any parameter type, and some parameters might accept
148 multiple values.
149  
150  
151  
152 =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>]
153  
154 A structure that describes the principals and the resource-level
155 permissions on an analysis. You can use the C<Permissions> structure to
156 grant permissions by providing a list of AWS Identity and Access
157 Management (IAM) action information for each principal listed by Amazon
158 Resource Name (ARN).
159  
160 To specify no permissions, omit C<Permissions>.
161  
162  
163  
164 =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::AnalysisSourceEntity>
165  
166 A source entity to use for the analysis that you're creating. This
167 metadata structure contains details that describe a source template and
168 one or more datasets.
169  
170  
171  
172 =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>]
173  
174 Contains a map of the key-value pairs for the resource tag or tags
175 assigned to the analysis.
176  
177  
178  
179 =head2 ThemeArn => Str
180  
181 The ARN for the theme to apply to the analysis that you're creating. To
182 see the theme in the QuickSight console, make sure that you have access
183 to it.
184  
185  
186  
187  
188 =head1 SEE ALSO
189  
190 This class forms part of L<Paws>, documenting arguments for method CreateAnalysis in L<Paws::Quicksight>
191  
192 =head1 BUGS and CONTRIBUTIONS
193  
194 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
195  
196 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
197  
198 =cut
199