WorkSpacesClient Class

Member Function Documentation

WorkSpacesClient::WorkSpacesClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a WorkSpacesClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

WorkSpacesClient::WorkSpacesClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads WorkSpacesClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateIpGroupsResponse *WorkSpacesClient::associateIpGroups(const AssociateIpGroupsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an AssociateIpGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates the specified IP access control group with the specified

[slot] AuthorizeIpRulesResponse *WorkSpacesClient::authorizeIpRules(const AuthorizeIpRulesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an AuthorizeIpRulesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds one or more rules to the specified IP access control

group>

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the

[slot] CreateIpGroupResponse *WorkSpacesClient::createIpGroup(const CreateIpGroupRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an CreateIpGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an IP access control

group>

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using

<a>AuthorizeIpRules</a>>

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your

[slot] CreateTagsResponse *WorkSpacesClient::createTags(const CreateTagsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an CreateTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates the specified tags for the specified

[slot] CreateWorkspacesResponse *WorkSpacesClient::createWorkspaces(const CreateWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an CreateWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates one or more

WorkSpaces>

This operation is asynchronous and returns before the WorkSpaces are

[slot] DeleteIpGroupResponse *WorkSpacesClient::deleteIpGroup(const DeleteIpGroupRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DeleteIpGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified IP access control

group>

You cannot delete an IP access control group that is associated with a

[slot] DeleteTagsResponse *WorkSpacesClient::deleteTags(const DeleteTagsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DeleteTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified tags from the specified

[slot] DescribeIpGroupsResponse *WorkSpacesClient::describeIpGroups(const DescribeIpGroupsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeIpGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes one or more of your IP access control

[slot] DescribeTagsResponse *WorkSpacesClient::describeTags(const DescribeTagsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified tags for the specified

[slot] DescribeWorkspaceBundlesResponse *WorkSpacesClient::describeWorkspaceBundles(const DescribeWorkspaceBundlesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeWorkspaceBundlesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the available WorkSpace

bundles>

You can filter the results using either bundle ID or owner, but not

[slot] DescribeWorkspaceDirectoriesResponse *WorkSpacesClient::describeWorkspaceDirectories(const DescribeWorkspaceDirectoriesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeWorkspaceDirectoriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the available AWS Directory Service directories that are registered with Amazon

[slot] DescribeWorkspacesResponse *WorkSpacesClient::describeWorkspaces(const DescribeWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified

WorkSpaces>

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a

[slot] DescribeWorkspacesConnectionStatusResponse *WorkSpacesClient::describeWorkspacesConnectionStatus(const DescribeWorkspacesConnectionStatusRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DescribeWorkspacesConnectionStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the connection status of the specified

[slot] DisassociateIpGroupsResponse *WorkSpacesClient::disassociateIpGroups(const DisassociateIpGroupsRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an DisassociateIpGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates the specified IP access control group from the specified

[slot] ModifyWorkspacePropertiesResponse *WorkSpacesClient::modifyWorkspaceProperties(const ModifyWorkspacePropertiesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an ModifyWorkspacePropertiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies the specified WorkSpace

[slot] ModifyWorkspaceStateResponse *WorkSpacesClient::modifyWorkspaceState(const ModifyWorkspaceStateRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an ModifyWorkspaceStateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the state of the specified

WorkSpace>

To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code>

[slot] RebootWorkspacesResponse *WorkSpacesClient::rebootWorkspaces(const RebootWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an RebootWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Reboots the specified

WorkSpaces>

You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or

<code>UNHEALTHY</code>>

This operation is asynchronous and returns before the WorkSpaces have

[slot] RebuildWorkspacesResponse *WorkSpacesClient::rebuildWorkspaces(const RebuildWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an RebuildWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Rebuilds the specified

WorkSpace>

You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, or

<code>UNHEALTHY</code>>

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href="http://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html">Rebuild a

WorkSpace</a>>

This operation is asynchronous and returns before the WorkSpaces have been completely

[slot] RevokeIpRulesResponse *WorkSpacesClient::revokeIpRules(const RevokeIpRulesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an RevokeIpRulesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes one or more rules from the specified IP access control

[slot] StartWorkspacesResponse *WorkSpacesClient::startWorkspaces(const StartWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an StartWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the specified

WorkSpaces>

You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of

[slot] StopWorkspacesResponse *WorkSpacesClient::stopWorkspaces(const StopWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an StopWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the specified

WorkSpaces>

You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or

[slot] TerminateWorkspacesResponse *WorkSpacesClient::terminateWorkspaces(const TerminateWorkspacesRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an TerminateWorkspacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Terminates the specified

WorkSpaces>

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the

WorkSpace>

You can terminate a WorkSpace that is in any state except

<code>SUSPENDED</code>>

This operation is asynchronous and returns before the WorkSpaces have been completely

[slot] UpdateRulesOfIpGroupResponse *WorkSpacesClient::updateRulesOfIpGroup(const UpdateRulesOfIpGroupRequest &request)

Sends request to the WorkSpacesClient service, and returns a pointer to an UpdateRulesOfIpGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Replaces the current rules of the specified IP access control group with the specified