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

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Quicksight::RegisterUser;
3 use Moose;
4 has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1);
5 has CustomFederationProviderUrl => (is => 'ro', isa => 'Str');
6 has CustomPermissionsName => (is => 'ro', isa => 'Str');
7 has Email => (is => 'ro', isa => 'Str', required => 1);
8 has ExternalLoginFederationProviderType => (is => 'ro', isa => 'Str');
9 has ExternalLoginId => (is => 'ro', isa => 'Str');
10 has IamArn => (is => 'ro', isa => 'Str');
11 has IdentityType => (is => 'ro', isa => 'Str', required => 1);
12 has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Namespace', required => 1);
13 has SessionName => (is => 'ro', isa => 'Str');
14 has UserName => (is => 'ro', isa => 'Str');
15 has UserRole => (is => 'ro', isa => 'Str', required => 1);
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterUser');
20 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users');
21 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::RegisterUserResponse');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::Quicksight::RegisterUser - Arguments for method RegisterUser on L<Paws::Quicksight>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method RegisterUser on the
34 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
35 as arguments to method RegisterUser.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterUser.
38  
39 =head1 SYNOPSIS
40  
41 my $quicksight = Paws->service('Quicksight');
42 my $RegisterUserResponse = $quicksight->RegisterUser(
43 AwsAccountId => 'MyAwsAccountId',
44 Email => 'MyString',
45 IdentityType => 'IAM',
46 Namespace => 'MyNamespace',
47 UserRole => 'ADMIN',
48 CustomFederationProviderUrl => 'MyString', # OPTIONAL
49 CustomPermissionsName => 'MyRoleName', # OPTIONAL
50 ExternalLoginFederationProviderType => 'MyString', # OPTIONAL
51 ExternalLoginId => 'MyString', # OPTIONAL
52 IamArn => 'MyString', # OPTIONAL
53 SessionName => 'MyRoleSessionName', # OPTIONAL
54 UserName => 'MyUserName', # OPTIONAL
55 );
56  
57 # Results:
58 my $RequestId = $RegisterUserResponse->RequestId;
59 my $Status = $RegisterUserResponse->Status;
60 my $User = $RegisterUserResponse->User;
61 my $UserInvitationUrl = $RegisterUserResponse->UserInvitationUrl;
62  
63 # Returns a L<Paws::Quicksight::RegisterUserResponse> object.
64  
65 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.
66 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/RegisterUser>
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 B<REQUIRED> AwsAccountId => Str
72  
73 The ID for the AWS account that the user is in. Currently, you use the
74 ID for the AWS account that contains your Amazon QuickSight account.
75  
76  
77  
78 =head2 CustomFederationProviderUrl => Str
79  
80 The URL of the custom OpenID Connect (OIDC) provider that provides
81 identity to let a user federate into QuickSight with an associated AWS
82 Identity and Access Management (IAM) role. This parameter should only
83 be used when C<ExternalLoginFederationProviderType> parameter is set to
84 C<CUSTOM_OIDC>.
85  
86  
87  
88 =head2 CustomPermissionsName => Str
89  
90 (Enterprise edition only) The name of the custom permissions profile
91 that you want to assign to this user. Customized permissions allows you
92 to control a user's access by restricting access the following
93 operations:
94  
95 =over
96  
97 =item *
98  
99 Create and update data sources
100  
101 =item *
102  
103 Create and update datasets
104  
105 =item *
106  
107 Create and update email reports
108  
109 =item *
110  
111 Subscribe to email reports
112  
113 =back
114  
115 To add custom permissions to an existing user, use C< UpdateUser >
116 instead.
117  
118 A set of custom permissions includes any combination of these
119 restrictions. Currently, you need to create the profile names for
120 custom permission sets by using the QuickSight console. Then, you use
121 the C<RegisterUser> API operation to assign the named set of
122 permissions to a QuickSight user.
123  
124 QuickSight custom permissions are applied through IAM policies.
125 Therefore, they override the permissions typically granted by assigning
126 QuickSight users to one of the default security cohorts in QuickSight
127 (admin, author, reader).
128  
129 This feature is available only to QuickSight Enterprise edition
130 subscriptions that use SAML 2.0-Based Federation for Single Sign-On
131 (SSO).
132  
133  
134  
135 =head2 B<REQUIRED> Email => Str
136  
137 The email address of the user that you want to register.
138  
139  
140  
141 =head2 ExternalLoginFederationProviderType => Str
142  
143 The type of supported external login provider that provides identity to
144 let a user federate into Amazon QuickSight with an associated AWS
145 Identity and Access Management (IAM) role. The type of supported
146 external login provider can be one of the following.
147  
148 =over
149  
150 =item *
151  
152 C<COGNITO>: Amazon Cognito. The provider URL is
153 cognito-identity.amazonaws.com. When choosing the C<COGNITO> provider
154 type, donE<rsquo>t use the "CustomFederationProviderUrl" parameter
155 which is only needed when the external provider is custom.
156  
157 =item *
158  
159 C<CUSTOM_OIDC>: Custom OpenID Connect (OIDC) provider. When choosing
160 C<CUSTOM_OIDC> type, use the C<CustomFederationProviderUrl> parameter
161 to provide the custom OIDC provider URL.
162  
163 =back
164  
165  
166  
167  
168 =head2 ExternalLoginId => Str
169  
170 The identity ID for a user in the external login provider.
171  
172  
173  
174 =head2 IamArn => Str
175  
176 The ARN of the IAM user or role that you are registering with Amazon
177 QuickSight.
178  
179  
180  
181 =head2 B<REQUIRED> IdentityType => Str
182  
183 Amazon QuickSight supports several ways of managing the identity of
184 users. This parameter accepts two values:
185  
186 =over
187  
188 =item *
189  
190 C<IAM>: A user whose identity maps to an existing IAM user or role.
191  
192 =item *
193  
194 C<QUICKSIGHT>: A user whose identity is owned and managed internally by
195 Amazon QuickSight.
196  
197 =back
198  
199  
200 Valid values are: C<"IAM">, C<"QUICKSIGHT">
201  
202 =head2 B<REQUIRED> Namespace => Str
203  
204 The namespace. Currently, you should set this to C<default>.
205  
206  
207  
208 =head2 SessionName => Str
209  
210 You need to use this parameter only when you register one or more users
211 using an assumed IAM role. You don't need to provide the session name
212 for other scenarios, for example when you are registering an IAM user
213 or an Amazon QuickSight user. You can register multiple users using the
214 same IAM role if each user has a different session name. For more
215 information on assuming IAM roles, see C<assume-role>
216 (https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)
217 in the I<AWS CLI Reference.>
218  
219  
220  
221 =head2 UserName => Str
222  
223 The Amazon QuickSight user name that you want to create for the user
224 you are registering.
225  
226  
227  
228 =head2 B<REQUIRED> UserRole => Str
229  
230 The Amazon QuickSight role for the user. The user role can be one of
231 the following:
232  
233 =over
234  
235 =item *
236  
237 C<READER>: A user who has read-only access to dashboards.
238  
239 =item *
240  
241 C<AUTHOR>: A user who can create data sources, datasets, analyses, and
242 dashboards.
243  
244 =item *
245  
246 C<ADMIN>: A user who is an author, who can also manage Amazon
247 QuickSight settings.
248  
249 =item *
250  
251 C<RESTRICTED_READER>: This role isn't currently available for use.
252  
253 =item *
254  
255 C<RESTRICTED_AUTHOR>: This role isn't currently available for use.
256  
257 =back
258  
259  
260 Valid values are: C<"ADMIN">, C<"AUTHOR">, C<"READER">, C<"RESTRICTED_AUTHOR">, C<"RESTRICTED_READER">
261  
262  
263 =head1 SEE ALSO
264  
265 This class forms part of L<Paws>, documenting arguments for method RegisterUser in L<Paws::Quicksight>
266  
267 =head1 BUGS and CONTRIBUTIONS
268  
269 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
270  
271 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
272  
273 =cut
274