« blib/lib/Paws/AppStream/ServiceAccountCredentials.pm
↑ Summary
blib/lib/Paws/AppStream/SharedImagePermissions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppStream::Session; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationType => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConnectionState => (is => 'ro', isa => 'Str'); | ||
| 6 | has FleetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has MaxExpirationTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has NetworkAccessConfiguration => (is => 'ro', isa => 'Paws::AppStream::NetworkAccessConfiguration'); | ||
| 10 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has State => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has UserId => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AppStream::Session | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::AppStream::Session object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { AuthenticationType => $value, ..., UserId => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppStream::Session object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->AuthenticationType | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Describes a streaming session. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 AuthenticationType => Str | ||
| 51 | |||
| 52 | The authentication method. The user is authenticated using a streaming | ||
| 53 | URL (C<API>) or SAML 2.0 federation (C<SAML>). | ||
| 54 | |||
| 55 | |||
| 56 | =head2 ConnectionState => Str | ||
| 57 | |||
| 58 | Specifies whether a user is connected to the streaming session. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> FleetName => Str | ||
| 62 | |||
| 63 | The name of the fleet for the streaming session. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Id => Str | ||
| 67 | |||
| 68 | The identifier of the streaming session. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxExpirationTime => Str | ||
| 72 | |||
| 73 | The time when the streaming session is set to expire. This time is | ||
| 74 | based on the C<MaxUserDurationinSeconds> value, which determines the | ||
| 75 | maximum length of time that a streaming session can run. A streaming | ||
| 76 | session might end earlier than the time specified in | ||
| 77 | C<SessionMaxExpirationTime>, when the C<DisconnectTimeOutInSeconds> | ||
| 78 | elapses or the user chooses to end his or her session. If the | ||
| 79 | C<DisconnectTimeOutInSeconds> elapses, or the user chooses to end his | ||
| 80 | or her session, the streaming instance is terminated and the streaming | ||
| 81 | session ends. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 NetworkAccessConfiguration => L<Paws::AppStream::NetworkAccessConfiguration> | ||
| 85 | |||
| 86 | The network details for the streaming session. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> StackName => Str | ||
| 90 | |||
| 91 | The name of the stack for the streaming session. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 StartTime => Str | ||
| 95 | |||
| 96 | The time when a streaming instance is dedicated for the user. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> State => Str | ||
| 100 | |||
| 101 | The current state of the streaming session. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> UserId => Str | ||
| 105 | |||
| 106 | The identifier of the user for whom the session was created. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, describing an object used in L<Paws::AppStream> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |