AWS SDK for C++  1.8.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::WorkSpaces::Model::DescribeWorkspacesRequest Class Reference

#include <DescribeWorkspacesRequest.h>

+ Inheritance diagram for Aws::WorkSpaces::Model::DescribeWorkspacesRequest:

Public Member Functions

 DescribeWorkspacesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetWorkspaceIds () const
 
bool WorkspaceIdsHasBeenSet () const
 
void SetWorkspaceIds (const Aws::Vector< Aws::String > &value)
 
void SetWorkspaceIds (Aws::Vector< Aws::String > &&value)
 
DescribeWorkspacesRequestWithWorkspaceIds (const Aws::Vector< Aws::String > &value)
 
DescribeWorkspacesRequestWithWorkspaceIds (Aws::Vector< Aws::String > &&value)
 
DescribeWorkspacesRequestAddWorkspaceIds (const Aws::String &value)
 
DescribeWorkspacesRequestAddWorkspaceIds (Aws::String &&value)
 
DescribeWorkspacesRequestAddWorkspaceIds (const char *value)
 
const Aws::StringGetDirectoryId () const
 
bool DirectoryIdHasBeenSet () const
 
void SetDirectoryId (const Aws::String &value)
 
void SetDirectoryId (Aws::String &&value)
 
void SetDirectoryId (const char *value)
 
DescribeWorkspacesRequestWithDirectoryId (const Aws::String &value)
 
DescribeWorkspacesRequestWithDirectoryId (Aws::String &&value)
 
DescribeWorkspacesRequestWithDirectoryId (const char *value)
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
DescribeWorkspacesRequestWithUserName (const Aws::String &value)
 
DescribeWorkspacesRequestWithUserName (Aws::String &&value)
 
DescribeWorkspacesRequestWithUserName (const char *value)
 
const Aws::StringGetBundleId () const
 
bool BundleIdHasBeenSet () const
 
void SetBundleId (const Aws::String &value)
 
void SetBundleId (Aws::String &&value)
 
void SetBundleId (const char *value)
 
DescribeWorkspacesRequestWithBundleId (const Aws::String &value)
 
DescribeWorkspacesRequestWithBundleId (Aws::String &&value)
 
DescribeWorkspacesRequestWithBundleId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeWorkspacesRequestWithLimit (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeWorkspacesRequestWithNextToken (const Aws::String &value)
 
DescribeWorkspacesRequestWithNextToken (Aws::String &&value)
 
DescribeWorkspacesRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::WorkSpaces::WorkSpacesRequest
virtual ~WorkSpacesRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file DescribeWorkspacesRequest.h.

Constructor & Destructor Documentation

◆ DescribeWorkspacesRequest()

Aws::WorkSpaces::Model::DescribeWorkspacesRequest::DescribeWorkspacesRequest ( )

Member Function Documentation

◆ AddWorkspaceIds() [1/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds ( const Aws::String value)
inline

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.

Definition at line 99 of file DescribeWorkspacesRequest.h.

◆ AddWorkspaceIds() [2/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds ( Aws::String &&  value)
inline

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.

Definition at line 108 of file DescribeWorkspacesRequest.h.

◆ AddWorkspaceIds() [3/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds ( const char *  value)
inline

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.

Definition at line 117 of file DescribeWorkspacesRequest.h.

◆ BundleIdHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::BundleIdHasBeenSet ( ) const
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 238 of file DescribeWorkspacesRequest.h.

◆ DirectoryIdHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::DirectoryIdHasBeenSet ( ) const
inline

The 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.

Definition at line 132 of file DescribeWorkspacesRequest.h.

◆ GetBundleId()

const Aws::String& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetBundleId ( ) const
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 231 of file DescribeWorkspacesRequest.h.

◆ GetDirectoryId()

const Aws::String& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetDirectoryId ( ) const
inline

The 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.

Definition at line 125 of file DescribeWorkspacesRequest.h.

◆ GetLimit()

int Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetLimit ( ) const
inline

The maximum number of items to return.

Definition at line 286 of file DescribeWorkspacesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetNextToken ( ) const
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 308 of file DescribeWorkspacesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file DescribeWorkspacesRequest.h.

◆ GetUserName()

const Aws::String& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetUserName ( ) const
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 181 of file DescribeWorkspacesRequest.h.

◆ GetWorkspaceIds()

const Aws::Vector<Aws::String>& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetWorkspaceIds ( ) const
inline

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.

Definition at line 45 of file DescribeWorkspacesRequest.h.

◆ LimitHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::LimitHasBeenSet ( ) const
inline

The maximum number of items to return.

Definition at line 291 of file DescribeWorkspacesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::NextTokenHasBeenSet ( ) const
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 314 of file DescribeWorkspacesRequest.h.

◆ SerializePayload()

Aws::String Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBundleId() [1/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId ( const Aws::String value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 245 of file DescribeWorkspacesRequest.h.

◆ SetBundleId() [2/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId ( Aws::String &&  value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 252 of file DescribeWorkspacesRequest.h.

◆ SetBundleId() [3/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId ( const char *  value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 259 of file DescribeWorkspacesRequest.h.

◆ SetDirectoryId() [1/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId ( const Aws::String value)
inline

The 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.

Definition at line 139 of file DescribeWorkspacesRequest.h.

◆ SetDirectoryId() [2/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId ( Aws::String &&  value)
inline

The 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.

Definition at line 146 of file DescribeWorkspacesRequest.h.

◆ SetDirectoryId() [3/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId ( const char *  value)
inline

The 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.

Definition at line 153 of file DescribeWorkspacesRequest.h.

◆ SetLimit()

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetLimit ( int  value)
inline

The maximum number of items to return.

Definition at line 296 of file DescribeWorkspacesRequest.h.

◆ SetNextToken() [1/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken ( const Aws::String value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 320 of file DescribeWorkspacesRequest.h.

◆ SetNextToken() [2/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken ( Aws::String &&  value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 326 of file DescribeWorkspacesRequest.h.

◆ SetNextToken() [3/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken ( const char *  value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 332 of file DescribeWorkspacesRequest.h.

◆ SetUserName() [1/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName ( const Aws::String value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 193 of file DescribeWorkspacesRequest.h.

◆ SetUserName() [2/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName ( Aws::String &&  value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 199 of file DescribeWorkspacesRequest.h.

◆ SetUserName() [3/3]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName ( const char *  value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 205 of file DescribeWorkspacesRequest.h.

◆ SetWorkspaceIds() [1/2]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetWorkspaceIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 63 of file DescribeWorkspacesRequest.h.

◆ SetWorkspaceIds() [2/2]

void Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetWorkspaceIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 72 of file DescribeWorkspacesRequest.h.

◆ UserNameHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::UserNameHasBeenSet ( ) const
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 187 of file DescribeWorkspacesRequest.h.

◆ WithBundleId() [1/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId ( const Aws::String value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 266 of file DescribeWorkspacesRequest.h.

◆ WithBundleId() [2/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId ( Aws::String &&  value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 273 of file DescribeWorkspacesRequest.h.

◆ WithBundleId() [3/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId ( const char *  value)
inline

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Definition at line 280 of file DescribeWorkspacesRequest.h.

◆ WithDirectoryId() [1/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId ( const Aws::String value)
inline

The 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.

Definition at line 160 of file DescribeWorkspacesRequest.h.

◆ WithDirectoryId() [2/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId ( Aws::String &&  value)
inline

The 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.

Definition at line 167 of file DescribeWorkspacesRequest.h.

◆ WithDirectoryId() [3/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId ( const char *  value)
inline

The 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.

Definition at line 174 of file DescribeWorkspacesRequest.h.

◆ WithLimit()

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithLimit ( int  value)
inline

The maximum number of items to return.

Definition at line 301 of file DescribeWorkspacesRequest.h.

◆ WithNextToken() [1/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken ( const Aws::String value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 338 of file DescribeWorkspacesRequest.h.

◆ WithNextToken() [2/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken ( Aws::String &&  value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 344 of file DescribeWorkspacesRequest.h.

◆ WithNextToken() [3/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken ( const char *  value)
inline

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Definition at line 350 of file DescribeWorkspacesRequest.h.

◆ WithUserName() [1/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName ( const Aws::String value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 211 of file DescribeWorkspacesRequest.h.

◆ WithUserName() [2/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName ( Aws::String &&  value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 217 of file DescribeWorkspacesRequest.h.

◆ WithUserName() [3/3]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName ( const char *  value)
inline

The name of the directory user. You must specify this parameter with DirectoryId.

Definition at line 223 of file DescribeWorkspacesRequest.h.

◆ WithWorkspaceIds() [1/2]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithWorkspaceIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 81 of file DescribeWorkspacesRequest.h.

◆ WithWorkspaceIds() [2/2]

DescribeWorkspacesRequest& Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithWorkspaceIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 90 of file DescribeWorkspacesRequest.h.

◆ WorkspaceIdsHasBeenSet()

bool Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WorkspaceIdsHasBeenSet ( ) const
inline

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.

Definition at line 54 of file DescribeWorkspacesRequest.h.


The documentation for this class was generated from the following file: