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