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

filter: Statementstmt 0.0% 0 / 30 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Quicksight::GetDashboardEmbedUrl;
3 use Moose;
4 has AdditionalDashboardIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'additional-dashboard-ids');
5 has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1);
6 has DashboardId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DashboardId', required => 1);
7 has IdentityType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'creds-type', required => 1);
8 has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespace');
9 has ResetDisabled => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'reset-disabled');
10 has SessionLifetimeInMinutes => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'session-lifetime');
11 has StatePersistenceEnabled => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'state-persistence-enabled');
12 has UndoRedoDisabled => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'undo-redo-disabled');
13 has UserArn => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'user-arn');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDashboardEmbedUrl');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::GetDashboardEmbedUrlResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Quicksight::GetDashboardEmbedUrl - Arguments for method GetDashboardEmbedUrl on L<Paws::Quicksight>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method GetDashboardEmbedUrl on the
32 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
33 as arguments to method GetDashboardEmbedUrl.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDashboardEmbedUrl.
36  
37 =head1 SYNOPSIS
38  
39 my $quicksight = Paws->service('Quicksight');
40 my $GetDashboardEmbedUrlResponse = $quicksight->GetDashboardEmbedUrl(
41 AwsAccountId => 'MyAwsAccountId',
42 DashboardId => 'MyRestrictiveResourceId',
43 IdentityType => 'IAM',
44 AdditionalDashboardIds => [
45 'MyRestrictiveResourceId', ... # min: 1, max: 2048
46 ], # OPTIONAL
47 Namespace => 'MyNamespace', # OPTIONAL
48 ResetDisabled => 1, # OPTIONAL
49 SessionLifetimeInMinutes => 1, # OPTIONAL
50 StatePersistenceEnabled => 1, # OPTIONAL
51 UndoRedoDisabled => 1, # OPTIONAL
52 UserArn => 'MyArn', # OPTIONAL
53 );
54  
55 # Results:
56 my $EmbedUrl = $GetDashboardEmbedUrlResponse->EmbedUrl;
57 my $RequestId = $GetDashboardEmbedUrlResponse->RequestId;
58 my $Status = $GetDashboardEmbedUrlResponse->Status;
59  
60 # Returns a L<Paws::Quicksight::GetDashboardEmbedUrlResponse> object.
61  
62 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.
63 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/GetDashboardEmbedUrl>
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 AdditionalDashboardIds => ArrayRef[Str|Undef]
69  
70 A list of one or more dashboard IDs that you want to add to a session
71 that includes anonymous users. The C<IdentityType> parameter must be
72 set to C<ANONYMOUS> for this to work, because other identity types
73 authenticate as QuickSight or IAM users. For example, if you set
74 "C<--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
75 identity-type ANONYMOUS>", the session can access all three dashboards.
76  
77  
78  
79 =head2 B<REQUIRED> AwsAccountId => Str
80  
81 The ID for the AWS account that contains the dashboard that you're
82 embedding.
83  
84  
85  
86 =head2 B<REQUIRED> DashboardId => Str
87  
88 The ID for the dashboard, also added to the AWS Identity and Access
89 Management (IAM) policy.
90  
91  
92  
93 =head2 B<REQUIRED> IdentityType => Str
94  
95 The authentication method that the user uses to sign in.
96  
97 Valid values are: C<"IAM">, C<"QUICKSIGHT">, C<"ANONYMOUS">
98  
99 =head2 Namespace => Str
100  
101 The QuickSight namespace that contains the dashboard IDs in this
102 request. If you're not using a custom namespace, set this to
103 "C<default>".
104  
105  
106  
107 =head2 ResetDisabled => Bool
108  
109 Remove the reset button on the embedded dashboard. The default is
110 FALSE, which enables the reset button.
111  
112  
113  
114 =head2 SessionLifetimeInMinutes => Int
115  
116 How many minutes the session is valid. The session lifetime must be
117 15-600 minutes.
118  
119  
120  
121 =head2 StatePersistenceEnabled => Bool
122  
123 Adds persistence of state for the user session in an embedded
124 dashboard. Persistence applies to the sheet and the parameter settings.
125 These are control settings that the dashboard subscriber (QuickSight
126 reader) chooses while viewing the dashboard. If this is set to C<TRUE>,
127 the settings are the same when the subscriber reopens the same
128 dashboard URL. The state is stored in QuickSight, not in a browser
129 cookie. If this is set to FALSE, the state of the user session is not
130 persisted. The default is C<FALSE>.
131  
132  
133  
134 =head2 UndoRedoDisabled => Bool
135  
136 Remove the undo/redo button on the embedded dashboard. The default is
137 FALSE, which enables the undo/redo button.
138  
139  
140  
141 =head2 UserArn => Str
142  
143 The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
144 C<QUICKSIGHT> identity type. You can use this for any Amazon QuickSight
145 users in your account (readers, authors, or admins) authenticated as
146 one of the following:
147  
148 =over
149  
150 =item *
151  
152 Active Directory (AD) users or group members
153  
154 =item *
155  
156 Invited nonfederated users
157  
158 =item *
159  
160 IAM users and IAM role-based sessions authenticated through Federated
161 Single Sign-On using SAML, OpenID Connect, or IAM federation.
162  
163 =back
164  
165 Omit this parameter for users in the third group E<ndash> IAM users and
166 IAM role-based sessions.
167  
168  
169  
170  
171 =head1 SEE ALSO
172  
173 This class forms part of L<Paws>, documenting arguments for method GetDashboardEmbedUrl in L<Paws::Quicksight>
174  
175 =head1 BUGS and CONTRIBUTIONS
176  
177 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
178  
179 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
180  
181 =cut
182