« blib/lib/Paws/AppStream/DescribeImagesResult.pm
↑ Summary
blib/lib/Paws/AppStream/DescribeSessionsResult.pm »
| 1 | |||
| 2 | package Paws::AppStream::DescribeSessions; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationType => (is => 'ro', isa => 'Str'); | ||
| 5 | has FleetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has UserId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSessions'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppStream::DescribeSessionsResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::AppStream::DescribeSessions - Arguments for method DescribeSessions on L<Paws::AppStream> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeSessions on the | ||
| 27 | L<Amazon AppStream|Paws::AppStream> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeSessions. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSessions. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $appstream2 = Paws->service('AppStream'); | ||
| 35 | my $DescribeSessionsResult = $appstream2->DescribeSessions( | ||
| 36 | FleetName => 'MyString', | ||
| 37 | StackName => 'MyString', | ||
| 38 | AuthenticationType => 'API', # OPTIONAL | ||
| 39 | Limit => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyString', # OPTIONAL | ||
| 41 | UserId => 'MyUserId', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $NextToken = $DescribeSessionsResult->NextToken; | ||
| 46 | my $Sessions = $DescribeSessionsResult->Sessions; | ||
| 47 | |||
| 48 | # Returns a L<Paws::AppStream::DescribeSessionsResult> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appstream2/DescribeSessions> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AuthenticationType => Str | ||
| 57 | |||
| 58 | The authentication method. Specify C<API> for a user authenticated | ||
| 59 | using a streaming URL or C<SAML> for a SAML federated user. The default | ||
| 60 | is to authenticate users using a streaming URL. | ||
| 61 | |||
| 62 | Valid values are: C<"API">, C<"SAML">, C<"USERPOOL"> | ||
| 63 | |||
| 64 | =head2 B<REQUIRED> FleetName => Str | ||
| 65 | |||
| 66 | The name of the fleet. This value is case-sensitive. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Limit => Int | ||
| 71 | |||
| 72 | The size of each page of results. The default value is 20 and the | ||
| 73 | maximum value is 50. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | The pagination token to use to retrieve the next page of results for | ||
| 80 | this operation. If this value is null, it retrieves the first page. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> StackName => Str | ||
| 85 | |||
| 86 | The name of the stack. This value is case-sensitive. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 UserId => Str | ||
| 91 | |||
| 92 | The user identifier (ID). If you specify a user ID, you must also | ||
| 93 | specify the authentication type. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method DescribeSessions in L<Paws::AppStream> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |