File Coverage

blib/lib/Paws/CognitoIdp/UpdateUserPoolClient.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CognitoIdp::UpdateUserPoolClient;
3 1     1   296 use Moose;
  1         3  
  1         6  
4             has AllowedOAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has AllowedOAuthFlowsUserPoolClient => (is => 'ro', isa => 'Bool');
6             has AllowedOAuthScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has CallbackURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has ClientId => (is => 'ro', isa => 'Str', required => 1);
9             has ClientName => (is => 'ro', isa => 'Str');
10             has DefaultRedirectURI => (is => 'ro', isa => 'Str');
11             has ExplicitAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
12             has LogoutURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has ReadAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14             has RefreshTokenValidity => (is => 'ro', isa => 'Int');
15             has SupportedIdentityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16             has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
17             has WriteAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
18              
19 1     1   5513 use MooseX::ClassAttribute;
  1         2  
  1         7  
20              
21             class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateUserPoolClient');
22             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::UpdateUserPoolClientResponse');
23             class_has _result_key => (isa => 'Str', is => 'ro');
24             1;
25              
26             ### main pod documentation begin ###
27              
28             =head1 NAME
29              
30             Paws::CognitoIdp::UpdateUserPoolClient - Arguments for method UpdateUserPoolClient on Paws::CognitoIdp
31              
32             =head1 DESCRIPTION
33              
34             This class represents the parameters used for calling the method UpdateUserPoolClient on the
35             Amazon Cognito Identity Provider service. Use the attributes of this class
36             as arguments to method UpdateUserPoolClient.
37              
38             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateUserPoolClient.
39              
40             As an example:
41              
42             $service_obj->UpdateUserPoolClient(Att1 => $value1, Att2 => $value2, ...);
43              
44             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.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 AllowedOAuthFlows => ArrayRef[Str|Undef]
50              
51             Set to C<code> to initiate a code grant flow, which provides an
52             authorization code as the response. This code can be exchanged for
53             access tokens with the token endpoint.
54              
55             Set to C<token> to specify that the client should get the access token
56             (and, optionally, ID token, based on scopes) directly.
57              
58              
59              
60             =head2 AllowedOAuthFlowsUserPoolClient => Bool
61              
62             Set to TRUE if the client is allowed to follow the OAuth protocol when
63             interacting with Cognito user pools.
64              
65              
66              
67             =head2 AllowedOAuthScopes => ArrayRef[Str|Undef]
68              
69             A list of allowed C<OAuth> scopes. Currently supported values are
70             C<"phone">, C<"email">, C<"openid">, and C<"Cognito">.
71              
72              
73              
74             =head2 CallbackURLs => ArrayRef[Str|Undef]
75              
76             A list of allowed callback URLs for the identity providers.
77              
78              
79              
80             =head2 B<REQUIRED> ClientId => Str
81              
82             The ID of the client associated with the user pool.
83              
84              
85              
86             =head2 ClientName => Str
87              
88             The client name from the update user pool client request.
89              
90              
91              
92             =head2 DefaultRedirectURI => Str
93              
94             The default redirect URI. Must be in the C<CallbackURLs> list.
95              
96              
97              
98             =head2 ExplicitAuthFlows => ArrayRef[Str|Undef]
99              
100             Explicit authentication flows.
101              
102              
103              
104             =head2 LogoutURLs => ArrayRef[Str|Undef]
105              
106             A list of allowed logout URLs for the identity providers.
107              
108              
109              
110             =head2 ReadAttributes => ArrayRef[Str|Undef]
111              
112             The read-only attributes of the user pool.
113              
114              
115              
116             =head2 RefreshTokenValidity => Int
117              
118             The time limit, in days, after which the refresh token is no longer
119             valid and cannot be used.
120              
121              
122              
123             =head2 SupportedIdentityProviders => ArrayRef[Str|Undef]
124              
125             A list of provider names for the identity providers that are supported
126             on this client.
127              
128              
129              
130             =head2 B<REQUIRED> UserPoolId => Str
131              
132             The user pool ID for the user pool where you want to update the user
133             pool client.
134              
135              
136              
137             =head2 WriteAttributes => ArrayRef[Str|Undef]
138              
139             The writeable attributes of the user pool.
140              
141              
142              
143              
144             =head1 SEE ALSO
145              
146             This class forms part of L<Paws>, documenting arguments for method UpdateUserPoolClient in L<Paws::CognitoIdp>
147              
148             =head1 BUGS and CONTRIBUTIONS
149              
150             The source code is located here: https://github.com/pplu/aws-sdk-perl
151              
152             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
153              
154             =cut
155