File Coverage

blib/lib/Paws/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity;
3 1     1   376 use Moose;
  1     1   3  
  1         7  
  1         1047  
  1         7  
  1         16  
4             has IdentityId => (is => 'ro', isa => 'Str');
5             has IdentityPoolId => (is => 'ro', isa => 'Str', required => 1);
6             has Logins => (is => 'ro', isa => 'Paws::CognitoIdentity::LoginsMap', required => 1);
7             has TokenDuration => (is => 'ro', isa => 'Int');
8              
9 1     1   5868 use MooseX::ClassAttribute;
  1     1   3  
  1         8  
  1         11612  
  1         4  
  1         14  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetOpenIdTokenForDeveloperIdentity');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity - Arguments for method GetOpenIdTokenForDeveloperIdentity on Paws::CognitoIdentity
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method GetOpenIdTokenForDeveloperIdentity on the
25             Amazon Cognito Identity service. Use the attributes of this class
26             as arguments to method GetOpenIdTokenForDeveloperIdentity.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetOpenIdTokenForDeveloperIdentity.
29              
30             As an example:
31              
32             $service_obj->GetOpenIdTokenForDeveloperIdentity(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 IdentityId => Str
40              
41             A unique identifier in the format REGION:GUID.
42              
43              
44              
45             =head2 B<REQUIRED> IdentityPoolId => Str
46              
47             An identity pool ID in the format REGION:GUID.
48              
49              
50              
51             =head2 B<REQUIRED> Logins => L<Paws::CognitoIdentity::LoginsMap>
52              
53             A set of optional name-value pairs that map provider names to provider
54             tokens. Each name-value pair represents a user from a public provider
55             or developer provider. If the user is from a developer provider, the
56             name-value pair will follow the syntax C<"developer_provider_name":
57             "developer_user_identifier">. The developer provider is the "domain" by
58             which Cognito will refer to your users; you provided this domain while
59             creating/updating the identity pool. The developer user identifier is
60             an identifier from your backend that uniquely identifies a user. When
61             you create an identity pool, you can specify the supported logins.
62              
63              
64              
65             =head2 TokenDuration => Int
66              
67             The expiration time of the token, in seconds. You can specify a custom
68             expiration time for the token so that you can cache it. If you don't
69             provide an expiration time, the token is valid for 15 minutes. You can
70             exchange the token with Amazon STS for temporary AWS credentials, which
71             are valid for a maximum of one hour. The maximum token duration you can
72             set is 24 hours. You should take care in setting the expiration time
73             for a token, as there are significant security implications: an
74             attacker could use a leaked token to access your AWS resources for the
75             token's duration.
76              
77              
78              
79              
80             =head1 SEE ALSO
81              
82             This class forms part of L<Paws>, documenting arguments for method GetOpenIdTokenForDeveloperIdentity in L<Paws::CognitoIdentity>
83              
84             =head1 BUGS and CONTRIBUTIONS
85              
86             The source code is located here: https://github.com/pplu/aws-sdk-perl
87              
88             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
89              
90             =cut
91