blib/lib/Paws/WorkSpaces/DescribeWorkspaces.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkSpaces::DescribeWorkspaces;
3 use Moose;
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 use MooseX::ClassAttribute;
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 L<Paws::WorkSpaces>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method DescribeWorkspaces on the
27 L<Amazon WorkSpaces|Paws::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 =head1 SYNOPSIS
33  
34 my $workspaces = Paws->service('WorkSpaces');
35 my $DescribeWorkspacesResult = $workspaces->DescribeWorkspaces(
36 BundleId => 'MyBundleId', # OPTIONAL
37 DirectoryId => 'MyDirectoryId', # OPTIONAL
38 Limit => 1, # OPTIONAL
39 NextToken => 'MyPaginationToken', # OPTIONAL
40 UserName => 'MyUserName', # OPTIONAL
41 WorkspaceIds => [ 'MyWorkspaceId', ... ], # OPTIONAL
42 );
43  
44 # Results:
45 my $NextToken = $DescribeWorkspacesResult->NextToken;
46 my $Workspaces = $DescribeWorkspacesResult->Workspaces;
47  
48 # Returns a L<Paws::WorkSpaces::DescribeWorkspacesResult> 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/workspaces/DescribeWorkspaces>
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 BundleId => Str
57  
58 The identifier of the bundle. All WorkSpaces that are created from this
59 bundle are retrieved. You cannot combine this parameter with any other
60 filter.
61  
62  
63  
64 =head2 DirectoryId => Str
65  
66 The identifier of the directory. In addition, you can optionally
67 specify a specific directory user (see C<UserName>). You cannot combine
68 this parameter with any other filter.
69  
70  
71  
72 =head2 Limit => Int
73  
74 The maximum number of items to return.
75  
76  
77  
78 =head2 NextToken => Str
79  
80 If you received a C<NextToken> from a previous call that was paginated,
81 provide this token to receive the next set of results.
82  
83  
84  
85 =head2 UserName => Str
86  
87 The name of the directory user. You must specify this parameter with
88 C<DirectoryId>.
89  
90  
91  
92 =head2 WorkspaceIds => ArrayRef[Str|Undef]
93  
94 The identifiers of the WorkSpaces. You cannot combine this parameter
95 with any other filter.
96  
97 Because the CreateWorkspaces operation is asynchronous, the identifier
98 it returns is not immediately available. If you immediately call
99 DescribeWorkspaces with this identifier, no information is returned.
100  
101  
102  
103  
104 =head1 SEE ALSO
105  
106 This class forms part of L<Paws>, documenting arguments for method DescribeWorkspaces in L<Paws::WorkSpaces>
107  
108 =head1 BUGS and CONTRIBUTIONS
109  
110 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
111  
112 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
113  
114 =cut
115