File Coverage

blib/lib/Paws/WorkSpaces/DescribeWorkspaces.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::WorkSpaces::DescribeWorkspaces;
3 1     1   577 use Moose;
  1         3  
  1         8  
4             has BundleId => (is => 'ro', isa => 'Str');
5             has DirectoryId => (is => 'ro', isa => 'Str');
6             has Limit => (is => 'ro', isa => 'Int');
7             has NextToken => (is => 'ro', isa => 'Str');
8             has UserName => (is => 'ro', isa => 'Str');
9             has WorkspaceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10              
11 1     1   6993 use MooseX::ClassAttribute;
  1         3  
  1         10  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeWorkspaces');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkSpaces::DescribeWorkspacesResult');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::WorkSpaces::DescribeWorkspaces - Arguments for method DescribeWorkspaces on Paws::WorkSpaces
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeWorkspaces on the
27             Amazon WorkSpaces service. Use the attributes of this class
28             as arguments to method DescribeWorkspaces.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeWorkspaces.
31              
32             As an example:
33              
34             $service_obj->DescribeWorkspaces(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 BundleId => Str
42              
43             The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces
44             that are created from this bundle will be retrieved. This parameter
45             cannot be combined with any other filter parameter.
46              
47              
48              
49             =head2 DirectoryId => Str
50              
51             Specifies the directory identifier to which to limit the WorkSpaces.
52             Optionally, you can specify a specific directory user with the
53             C<UserName> parameter. This parameter cannot be combined with any other
54             filter parameter.
55              
56              
57              
58             =head2 Limit => Int
59              
60             The maximum number of items to return.
61              
62              
63              
64             =head2 NextToken => Str
65              
66             The C<NextToken> value from a previous call to this operation. Pass
67             null if this is the first call.
68              
69              
70              
71             =head2 UserName => Str
72              
73             Used with the C<DirectoryId> parameter to specify the directory user
74             for whom to obtain the WorkSpace.
75              
76              
77              
78             =head2 WorkspaceIds => ArrayRef[Str|Undef]
79              
80             An array of strings that contain the identifiers of the WorkSpaces for
81             which to retrieve information. This parameter cannot be combined with
82             any other filter parameter.
83              
84             Because the CreateWorkspaces operation is asynchronous, the identifier
85             it returns is not immediately available. If you immediately call
86             DescribeWorkspaces with this identifier, no information is returned.
87              
88              
89              
90              
91             =head1 SEE ALSO
92              
93             This class forms part of L<Paws>, documenting arguments for method DescribeWorkspaces in L<Paws::WorkSpaces>
94              
95             =head1 BUGS and CONTRIBUTIONS
96              
97             The source code is located here: https://github.com/pplu/aws-sdk-perl
98              
99             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
100              
101             =cut
102