« blib/lib/Paws/Quicksight/UploadSettings.pm
↑ Summary
blib/lib/Paws/Quicksight/VpcConnectionProperties.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Quicksight::User; | ||
| 3 | use Moose; | ||
| 4 | has Active => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 6 | has CustomPermissionsName => (is => 'ro', isa => 'Str'); | ||
| 7 | has Email => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExternalLoginFederationProviderType => (is => 'ro', isa => 'Str'); | ||
| 9 | has ExternalLoginFederationProviderUrl => (is => 'ro', isa => 'Str'); | ||
| 10 | has ExternalLoginId => (is => 'ro', isa => 'Str'); | ||
| 11 | has IdentityType => (is => 'ro', isa => 'Str'); | ||
| 12 | has PrincipalId => (is => 'ro', isa => 'Str'); | ||
| 13 | has Role => (is => 'ro', isa => 'Str'); | ||
| 14 | has UserName => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Quicksight::User | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::Quicksight::User object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Active => $value, ..., UserName => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::Quicksight::User object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Active | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | A registered user of Amazon QuickSight. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Active => Bool | ||
| 52 | |||
| 53 | The active status of user. When you create an Amazon QuickSight user | ||
| 54 | thatE<rsquo>s not an IAM user or an Active Directory user, that user is | ||
| 55 | inactive until they sign in and provide a password. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Arn => Str | ||
| 59 | |||
| 60 | The Amazon Resource Name (ARN) for the user. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CustomPermissionsName => Str | ||
| 64 | |||
| 65 | The custom permissions profile associated with this user. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Email => Str | ||
| 69 | |||
| 70 | The user's email address. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ExternalLoginFederationProviderType => Str | ||
| 74 | |||
| 75 | The type of supported external login provider that provides identity to | ||
| 76 | let the user federate into Amazon QuickSight with an associated IAM | ||
| 77 | role. The type can be one of the following. | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<COGNITO>: Amazon Cognito. The provider URL is | ||
| 84 | cognito-identity.amazonaws.com. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<CUSTOM_OIDC>: Custom OpenID Connect (OIDC) provider. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ExternalLoginFederationProviderUrl => Str | ||
| 95 | |||
| 96 | The URL of the external login provider. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 ExternalLoginId => Str | ||
| 100 | |||
| 101 | The identity ID for the user in the external login provider. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 IdentityType => Str | ||
| 105 | |||
| 106 | The type of identity authentication used by the user. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 PrincipalId => Str | ||
| 110 | |||
| 111 | The principal ID of the user. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Role => Str | ||
| 115 | |||
| 116 | The Amazon QuickSight role for the user. The user role can be one of | ||
| 117 | the following:. | ||
| 118 | |||
| 119 | =over | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<READER>: A user who has read-only access to dashboards. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<AUTHOR>: A user who can create data sources, datasets, analyses, and | ||
| 128 | dashboards. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<ADMIN>: A user who is an author, who can also manage Amazon | ||
| 133 | QuickSight settings. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<RESTRICTED_READER>: This role isn't currently available for use. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<RESTRICTED_AUTHOR>: This role isn't currently available for use. | ||
| 142 | |||
| 143 | =back | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 UserName => Str | ||
| 148 | |||
| 149 | The user's user name. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head1 SEE ALSO | ||
| 154 | |||
| 155 | This class forms part of L<Paws>, describing an object used in L<Paws::Quicksight> | ||
| 156 | |||
| 157 | =head1 BUGS and CONTRIBUTIONS | ||
| 158 | |||
| 159 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 160 | |||
| 161 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 162 | |||
| 163 | =cut | ||
| 164 |