File Coverage

blib/lib/Paws/CodeStar/UserProfileSummary.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CodeStar::UserProfileSummary;
2 1     1   453 use Moose;
  1         3  
  1         7  
3             has DisplayName => (is => 'ro', isa => 'Str', request_name => 'displayName', traits => ['NameInRequest']);
4             has EmailAddress => (is => 'ro', isa => 'Str', request_name => 'emailAddress', traits => ['NameInRequest']);
5             has SshPublicKey => (is => 'ro', isa => 'Str', request_name => 'sshPublicKey', traits => ['NameInRequest']);
6             has UserArn => (is => 'ro', isa => 'Str', request_name => 'userArn', traits => ['NameInRequest']);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CodeStar::UserProfileSummary
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::CodeStar::UserProfileSummary object:
25              
26             $service_obj->Method(Att1 => { DisplayName => $value, ..., UserArn => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeStar::UserProfileSummary object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->DisplayName
34              
35             =head1 DESCRIPTION
36              
37             Information about a user's profile in AWS CodeStar.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 DisplayName => Str
43              
44             The display name of a user in AWS CodeStar. For example, this could be
45             set to both first and last name ("Mary Major") or a single name
46             ("Mary"). The display name is also used to generate the initial icon
47             associated with the user in AWS CodeStar projects. If spaces are
48             included in the display name, the first character that appears after
49             the space will be used as the second character in the user initial
50             icon. The initial icon displays a maximum of two characters, so a
51             display name with more than one space (for example "Mary Jane Major")
52             would generate an initial icon using the first character and the first
53             character after the space ("MJ", not "MM").
54              
55              
56             =head2 EmailAddress => Str
57              
58             The email address associated with the user.
59              
60              
61             =head2 SshPublicKey => Str
62              
63             The SSH public key associated with the user in AWS CodeStar. If a
64             project owner allows the user remote access to project resources, this
65             public key will be used along with the user's private key for SSH
66             access.
67              
68              
69             =head2 UserArn => Str
70              
71             The Amazon Resource Name (ARN) of the user in IAM.
72              
73              
74              
75             =head1 SEE ALSO
76              
77             This class forms part of L<Paws>, describing an object used in L<Paws::CodeStar>
78              
79             =head1 BUGS and CONTRIBUTIONS
80              
81             The source code is located here: https://github.com/pplu/aws-sdk-perl
82              
83             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
84              
85             =cut
86