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

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