blib/lib/Paws/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/CloudWatchLogs/SearchedLogStream.pm ↑ Summary blib/lib/Paws/CognitoIdentity/LoginsMap.pm »
1  
2 package Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has IdentityId => (is => 'ro', isa => 'Str');
5 1 has IdentityPoolId => (is => 'ro', isa => 'Str', required => 1);
6 1 has Logins => (is => 'ro', isa => 'Paws::CognitoIdentity::LoginsMap', required => 1);
7 1 has PrincipalTags => (is => 'ro', isa => 'Paws::CognitoIdentity::PrincipalTags');
8 1 has TokenDuration => (is => 'ro', isa => 'Int');
9  
10 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetOpenIdTokenForDeveloperIdentity');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse');
14 1 class_has _result_key => (isa => 'Str', is => 'ro');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity - Arguments for method GetOpenIdTokenForDeveloperIdentity on L<Paws::CognitoIdentity>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method GetOpenIdTokenForDeveloperIdentity on the
26 L<Amazon Cognito Identity|Paws::CognitoIdentity> service. Use the attributes of this class
27 as arguments to method GetOpenIdTokenForDeveloperIdentity.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetOpenIdTokenForDeveloperIdentity.
30  
31 =head1 SYNOPSIS
32  
33 my $cognito-identity = Paws->service('CognitoIdentity');
34 my $GetOpenIdTokenForDeveloperIdentityResponse =
35 $cognito -identity->GetOpenIdTokenForDeveloperIdentity(
36 IdentityPoolId => 'MyIdentityPoolId',
37 Logins => {
38 'MyIdentityProviderName' => 'MyIdentityProviderToken'
39 , # key: min: 1, max: 128, value: min: 1, max: 50000
40 },
41 IdentityId => 'MyIdentityId', # OPTIONAL
42 PrincipalTags => {
43 'MyPrincipalTagID' => 'MyPrincipalTagValue'
44 , # key: min: 1, max: 128, value: min: 1, max: 256
45 }, # OPTIONAL
46 TokenDuration => 1, # OPTIONAL
47 );
48  
49 # Results:
50 my $IdentityId = $GetOpenIdTokenForDeveloperIdentityResponse->IdentityId;
51 my $Token = $GetOpenIdTokenForDeveloperIdentityResponse->Token;
52  
53 # Returns a L<Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cognito-identity/GetOpenIdTokenForDeveloperIdentity>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 IdentityId => Str
62  
63 A unique identifier in the format REGION:GUID.
64  
65  
66  
67 =head2 B<REQUIRED> IdentityPoolId => Str
68  
69 An identity pool ID in the format REGION:GUID.
70  
71  
72  
73 =head2 B<REQUIRED> Logins => L<Paws::CognitoIdentity::LoginsMap>
74  
75 A set of optional name-value pairs that map provider names to provider
76 tokens. Each name-value pair represents a user from a public provider
77 or developer provider. If the user is from a developer provider, the
78 name-value pair will follow the syntax C<"developer_provider_name":
79 "developer_user_identifier">. The developer provider is the "domain" by
80 which Cognito will refer to your users; you provided this domain while
81 creating/updating the identity pool. The developer user identifier is
82 an identifier from your backend that uniquely identifies a user. When
83 you create an identity pool, you can specify the supported logins.
84  
85  
86  
87 =head2 PrincipalTags => L<Paws::CognitoIdentity::PrincipalTags>
88  
89 Use this operation to configure attribute mappings for custom
90 providers.
91  
92  
93  
94 =head2 TokenDuration => Int
95  
96 The expiration time of the token, in seconds. You can specify a custom
97 expiration time for the token so that you can cache it. If you don't
98 provide an expiration time, the token is valid for 15 minutes. You can
99 exchange the token with Amazon STS for temporary AWS credentials, which
100 are valid for a maximum of one hour. The maximum token duration you can
101 set is 24 hours. You should take care in setting the expiration time
102 for a token, as there are significant security implications: an
103 attacker could use a leaked token to access your AWS resources for the
104 token's duration.
105  
106 Please provide for a small grace period, usually no more than 5
107 minutes, to account for clock skew.
108  
109  
110  
111  
112 =head1 SEE ALSO
113  
114 This class forms part of L<Paws>, documenting arguments for method GetOpenIdTokenForDeveloperIdentity in L<Paws::CognitoIdentity>
115  
116 =head1 BUGS and CONTRIBUTIONS
117  
118 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
119  
120 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
121  
122 =cut
123  
« blib/lib/Paws/CloudWatchLogs/SearchedLogStream.pm ↑ Summary blib/lib/Paws/CognitoIdentity/LoginsMap.pm »