![]() |
![]()
| ![]() |
![]()
NAMEPaws::WorkSpaces::DescribeWorkspaces - Arguments for method DescribeWorkspaces on Paws::WorkSpaces DESCRIPTIONThis class represents the parameters used for calling the method DescribeWorkspaces on the Amazon WorkSpaces service. Use the attributes of this class as arguments to method DescribeWorkspaces. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeWorkspaces. SYNOPSISmy $workspaces = Paws->service('WorkSpaces'); my $DescribeWorkspacesResult = $workspaces->DescribeWorkspaces( BundleId => 'MyBundleId', # OPTIONAL DirectoryId => 'MyDirectoryId', # OPTIONAL Limit => 1, # OPTIONAL NextToken => 'MyPaginationToken', # OPTIONAL UserName => 'MyUserName', # OPTIONAL WorkspaceIds => [ 'MyWorkspaceId', ... ], # OPTIONAL ); # Results: my $NextToken = $DescribeWorkspacesResult->NextToken; my $Workspaces = $DescribeWorkspacesResult->Workspaces; # Returns a L<Paws::WorkSpaces::DescribeWorkspacesResult> object. 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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/workspaces/DescribeWorkspaces> ATTRIBUTESBundleId => StrThe identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter. DirectoryId => StrThe identifier of the directory. In addition, you can optionally specify a specific directory user (see "UserName"). You cannot combine this parameter with any other filter. Limit => IntThe maximum number of items to return. NextToken => StrIf you received a "NextToken" from a previous call that was paginated, provide this token to receive the next set of results. UserName => StrThe name of the directory user. You must specify this parameter with "DirectoryId". WorkspaceIds => ArrayRef[Str|Undef]The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned. SEE ALSOThis class forms part of Paws, documenting arguments for method DescribeWorkspaces in Paws::WorkSpaces BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|